com.wewebu.ow.server.ecm.bpm

Interface OwWorkitem

All Superinterfaces:

OwFieldProvider, OwObject, OwObjectReference

public interface OwWorkitem
extends OwObject

Base interface for Workitem containers, or BPM Queues.

To be implemented with the specific BPM system.

Alfresco Workdesk
Copyright (c) Alfresco Software, Inc.
All rights reserved.

For licensing information read the license.txt file or
go to: http://wiki.alfresco.com

Field Summary

Fields inherited from interface com.wewebu.ow.server.ecm.OwObject

STANDARD_PATH_DELIMITER

Fields inherited from interface com.wewebu.ow.server.ecm.OwObjectReference

OBJECT_TYPE_ALL_CONTAINER_OBJECTS, OBJECT_TYPE_ALL_CONTENT_OBJECTS, OBJECT_TYPE_ALL_TUPLE_OBJECTS, OBJECT_TYPE_ALL_WORKFLOW_OBJECTS, OBJECT_TYPE_BPM_ROOT_FOLDER, OBJECT_TYPE_CONTAINER_USER_START, OBJECT_TYPE_CONTENT_USER_START, OBJECT_TYPE_CROSS_QUEUE_FOLDER, OBJECT_TYPE_CUSTOM, OBJECT_TYPE_DOCUMENT, OBJECT_TYPE_DYNAMIC_VIRTUAL_FOLDER, OBJECT_TYPE_ECM_ROOT_FOLDER, OBJECT_TYPE_FOLDER, OBJECT_TYPE_HISTORY, OBJECT_TYPE_LINK, OBJECT_TYPE_PROXY_QUEUE_FOLDER, OBJECT_TYPE_PUBLIC_QUEUE_FOLDER, OBJECT_TYPE_ROSTER_FOLDER, OBJECT_TYPE_ROSTERITEM, OBJECT_TYPE_STORED_SEARCH, OBJECT_TYPE_SYS_QUEUE_FOLDER, OBJECT_TYPE_TRACKER_QUEUE_FOLDER, OBJECT_TYPE_TUPLE_USER_START, OBJECT_TYPE_UNDEFINED, OBJECT_TYPE_USER_QUEUE_FOLDER, OBJECT_TYPE_VIRTUAL_FOLDER, OBJECT_TYPE_WORKFLOW_USER_START, OBJECT_TYPE_WORKITEM, OBJECT_TYPE_WORKITEM_PROXY, OBJECT_TYPE_WORKITEM_TRACKER

Fields inherited from interface com.wewebu.ow.server.field.OwFieldProvider

TYPE_AJAX, TYPE_CHECKIN_OBJECT, TYPE_CREATE_OBJECT, TYPE_META_OBJECT, TYPE_RESULT_LIST, TYPE_SEARCH, TYPE_SMALL

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canDispatch(int iContext_p) check if you can dispatch the workitem, move it to the next public queue
boolean	canForcedelete(int iContext_p) check if deletion of object and all references, regardless of any state is possible / allowed
boolean	canReassignToPublicContainer(int iContext_p) check if you can reassign the work item
boolean	canReassignToUserContainer(int iContext_p) check if you can reassign the work item
boolean	canResponse() check if you can set a response
boolean	canResubmit(int iContext_p) check if you can resubmit the work item to
boolean	canReturnToSource(int iContext_p) check if you can return the work item to the source from where it has been moved
void	dispatch() dispatch the workitem, move it to the next public queue
void	forcedelete() delete object and all references, regardless of any state
String	getResponse() get a response
Collection	getResponses() get a list of possible responses
Date	getResubmitDate(int iContext_p) get the currently set resubmit date
OwWorkitemProcessorInfo	getStepProcessorInfo() get a step processor info class for the work item
void	reassignToPublicContainer(String containername_p, boolean delegateFlag_p) reassign the workitem.
void	reassignToUserContainer(String participant_p, boolean delegateFlag_p) reassign the workitem.
void	resubmit(Date date_p) resubmit the work item to the given date
void	returnToSource() return the work item to the source from where it has been moved
void	setResponse(String strResponse_p) set a response

Methods inherited from interface com.wewebu.ow.server.ecm.OwObject

add, canAdd, canChangeClass, canDelete, canFilterChilds, canGetContent, canGetPermissions, canGetProperties, canLock, canMove, canRemoveReference, canSetContent, canSetPermissions, canSetProperties, changeClass, delete, getChildCount, getChilds, getClassName, getClonedPermissions, getClonedProperties, getColumnInfoList, getContentCollection, getFilterProperties, getLock, getLockUserID, getMyLock, getNativeObject, getObjectClass, getParents, getPath, getPermissions, getProperties, getProperty, getResource, getSearchTemplate, getVersion, getVersionSeries, hasChilds, hasVersionSeries, move, refreshProperties, refreshProperties, removeReference, setContentCollection, setLock, setPermissions, setProperties, setProperties

Methods inherited from interface com.wewebu.ow.server.ecm.OwObjectReference

getDMSID, getID, getInstance, getMIMEParameter, getMIMEType, getName, getPageCount, getResourceID, getType, hasContent

Methods inherited from interface com.wewebu.ow.server.field.OwFieldProvider

getField, getFieldProviderName, getFieldProviderSource, getFieldProviderType, getFields, getSafeFieldValue, setField

Method Detail

getStepProcessorInfo

OwWorkitemProcessorInfo getStepProcessorInfo()
                                             throws OwObjectNotFoundException

get a step processor info class for the work item

Returns:

OwWorkitemProcessorInfo

Throws:

OwObjectNotFoundException

setResponse

void setResponse(String strResponse_p)
                 throws Exception

set a response

Throws:

Exception

canResponse

boolean canResponse()

check if you can set a response

Returns:

boolean

getResponse

String getResponse()
                   throws Exception

get a response

Throws:

Exception

getResponses

Collection getResponses()
                        throws Exception

get a list of possible responses

Returns:

Collection of OwEnum

Throws:

Exception

forcedelete

void forcedelete()
                 throws Exception

delete object and all references, regardless of any state

Throws:

Exception

canForcedelete

boolean canForcedelete(int iContext_p)
                       throws Exception

check if deletion of object and all references, regardless of any state is possible / allowed

Parameters:

iContext_p - OwStatusContextDefinitions

Returns:

boolean

Throws:

Exception

dispatch

void dispatch()
              throws Exception

dispatch the workitem, move it to the next public queue

Throws:

Exception

canDispatch

boolean canDispatch(int iContext_p)
                    throws Exception

check if you can dispatch the workitem, move it to the next public queue

Parameters:

iContext_p - OwStatusContextDefinitions

Throws:

Exception

returnToSource

void returnToSource()
                    throws Exception

return the work item to the source from where it has been moved

Throws:

Exception

canReturnToSource

boolean canReturnToSource(int iContext_p)
                          throws Exception

check if you can return the work item to the source from where it has been moved

Parameters:

iContext_p - OwStatusContextDefinitions

Returns:

boolean

Throws:

Exception

reassignToPublicContainer

void reassignToPublicContainer(String containername_p,
                             boolean delegateFlag_p)
                               throws Exception

reassign the workitem.

Parameters:

containername_p - String

delegateFlag_p - A boolean value. Specify true if you delegate the assignment and plan to review the completed assignment; otherwise specify false.

Throws:

Exception

reassignToUserContainer

void reassignToUserContainer(String participant_p,
                           boolean delegateFlag_p)
                             throws Exception

reassign the workitem.

Parameters:

participant_p - String

delegateFlag_p - A boolean value. Specify true if you delegate the assignment and plan to review the completed assignment; otherwise specify false.

Throws:

Exception

canReassignToPublicContainer

boolean canReassignToPublicContainer(int iContext_p)
                                     throws Exception

check if you can reassign the work item

Parameters:

iContext_p - OwStatusContextDefinitions

Returns:

boolean

Throws:

Exception

canReassignToUserContainer

boolean canReassignToUserContainer(int iContext_p)
                                   throws Exception

check if you can reassign the work item

Parameters:

iContext_p - OwStatusContextDefinitions

Returns:

boolean

Throws:

Exception

resubmit

void resubmit(Date date_p)
              throws Exception

resubmit the work item to the given date

Parameters:

date_p - the date to resubmit, or null to clear resubmission

Throws:

Exception

canResubmit

boolean canResubmit(int iContext_p)
                    throws Exception

check if you can resubmit the work item to

Parameters:

iContext_p - OwStatusContextDefinitions

Returns:

boolean

Throws:

Exception

getResubmitDate

Date getResubmitDate(int iContext_p)
                     throws Exception

get the currently set resubmit date

Parameters:

iContext_p - OwStatusContextDefinitions

Returns:

Date or null if no resubmission is active

Throws:

Exception