TaskWorkerControl Interface

com.bea.control
TaskWorkerControl Interface

public interface TaskWorkerControl

    extends Control

The Task Worker control enables a business process or UI to assume ownership of Tasks, work on them, and complete them. It offers administrative operations, such as operations to start, stop, delete, and assign. The Task Worker controls allow operations on several Task instances simultaneously. You can extend this control.


All Superinterfaces
Control, Control, Serializable

Nested Class Summary

 
Nested classes from interface com.bea.control.Control
Control.Callback
 

Field Summary

public static final String
ATTR_ASSIGN_ALGORITHM
String
public static final String
ATTR_ASSIGN_GROUP
String
public static final String
ATTR_ASSIGN_USER
String
public static final String
ATTR_CLAIM_CLAIMANT
String
public static final String
ATTR_CREATE_CAN_BE_ABORTED
String
public static final String
ATTR_CREATE_CAN_BE_REASSIGNED
String
public static final String
ATTR_CREATE_CAN_BE_RETURNED
String
public static final String
ATTR_CREATE_CLAIM_CALENDAR
String
public static final String
ATTR_CREATE_CLAIM_DUE_BUSINESS_DATE
String
public static final String
ATTR_CREATE_CLAIM_DUE_DATE
String
public static final String
ATTR_CREATE_CLAIM_USER_CALENDAR
String
public static final String
ATTR_CREATE_COMMENT
String
public static final String
ATTR_CREATE_COMPLETION_CALENDAR
String
public static final String
ATTR_CREATE_COMPLETION_DUE_BUSINESS_DATE
String
public static final String
ATTR_CREATE_COMPLETION_DUE_DATE
String
public static final String
ATTR_CREATE_COMPLETION_USER_CALENDAR
String
public static final String
ATTR_CREATE_DESCRIPTION
String
public static final String
ATTR_CREATE_NAME
String
public static final String
ATTR_CREATE_OWNER
String
public static final String
ATTR_CREATE_PRIORITY
String
public static final String
ATTR_CREATE_REQUEST
String
public static final String
ATTR_CREATE_REQUEST_MIME_TYPE
String
public static final String
ATTR_GET_PROPERTY_NAME
String
public static final String
ATTR_REMOVE_PROPERTY_NAME
String
public static final String
ATTR_SELECT_ASSIGNED_GROUP
String
public static final String
ATTR_SELECT_ASSIGNED_USER
String
public static final String
ATTR_SELECT_CLAIM_DUE_DATE_AFTER
String
public static final String
ATTR_SELECT_CLAIM_DUE_DATE_BEFORE
String
public static final String
ATTR_SELECT_CLAIMANT
String
public static final String
ATTR_SELECT_COMPLETION_DUE_DATE_AFTER
String
public static final String
ATTR_SELECT_COMPLETION_DUE_DATE_BEFORE
String
public static final String
ATTR_SELECT_CREATION_DATE_AFTER
String
public static final String
ATTR_SELECT_CREATION_DATE_BEFORE
String
public static final String
ATTR_SELECT_MAX_PRIORITY
String
public static final String
ATTR_SELECT_MIN_PRIORITY
String
public static final String
ATTR_SELECT_PROPERTY_NAME
String
public static final String
ATTR_SELECT_PROPERTY_VALUE
String
public static final String
ATTR_SELECT_SELECTOR
String
public static final String
ATTR_SELECT_STATES
String
public static final String
ATTR_SELECT_TASK_COMMENT
String
public static final String
ATTR_SELECT_TASK_ID
String
public static final String
ATTR_SELECT_TASK_NAME
String
public static final String
ATTR_SELECT_TASK_OWNER
String
public static final String
ATTR_SET_PROPERTY_NAME
String
public static final String
ATTR_SET_PROPERTY_VALUE
String
public static final String
ATTR_UPDATE_CAN_BE_ABORTED
String
public static final String
ATTR_UPDATE_CAN_BE_REASSIGNED
String
public static final String
ATTR_UPDATE_CAN_BE_RETURNED
String
public static final String
ATTR_UPDATE_CLAIM_CALENDAR
String
public static final String
ATTR_UPDATE_CLAIM_DUE_BUSINESS_DATE
String
public static final String
ATTR_UPDATE_CLAIM_DUE_DATE
String
public static final String
ATTR_UPDATE_CLAIM_USER_CALENDAR
String
public static final String
ATTR_UPDATE_COMMENT
String
public static final String
ATTR_UPDATE_COMPLETION_CALENDAR
String
public static final String
ATTR_UPDATE_COMPLETION_DUE_BUSINESS_DATE
String
public static final String
ATTR_UPDATE_COMPLETION_DUE_DATE
String
public static final String
ATTR_UPDATE_COMPLETION_USER_CALENDAR
String
public static final String
ATTR_UPDATE_OWNER
String
public static final String
ATTR_UPDATE_PRIORITY
String
public static final String
ATTR_UPDATE_REQUEST
String
public static final String
ATTR_UPDATE_REQUEST_MIME_TYPE
String
public static final String
ATTR_UPDATE_RESPONSE
String
public static final String
ATTR_UPDATE_RESPONSE_MIME_TYPE
String
public static final String
TAG_TASK_WORKER
the control jc tag.
public static final String
TAG_TASK_WORKER_ABORT
String
public static final String
TAG_TASK_WORKER_ASSIGN
The @jc:task-assign tag is used to annotate a JBCX method that assign or reassign a task.
public static final String
TAG_TASK_WORKER_CLAIM
String
public static final String
TAG_TASK_WORKER_COMPLETE
String
public static final String
TAG_TASK_WORKER_CREATE
The @jc:create tag is used to annotate a JBCX method that creates a new task.
public static final String
TAG_TASK_WORKER_DELETE
String
public static final String
TAG_TASK_WORKER_GET_INFO
The return type of the method JBCX is used to determine what is returned: TaskInfo[] TaskInfoXML[]
public static final String
TAG_TASK_WORKER_GET_PROPERTY
String
public static final String
TAG_TASK_WORKER_GET_PROPERTY_NAME
String
public static final String
TAG_TASK_WORKER_GET_REQUEST
The return type of the method JBCX is used to determine what is returned.
public static final String
TAG_TASK_WORKER_GET_RESPONSE
The return type of the method JBCX is used to determine what is returned.
public static final String
TAG_TASK_WORKER_REMOVE_PROPERTY
String
public static final String
TAG_TASK_WORKER_RESUME
String
public static final String
TAG_TASK_WORKER_RETURN
String
public static final String
TAG_TASK_WORKER_SELECT
The @jc:task-select tag is used in correlation with the other method tags of this control.
public static final String
TAG_TASK_WORKER_SET_PROPERTY
String
public static final String
TAG_TASK_WORKER_START
String
public static final String
TAG_TASK_WORKER_STOP
String
public static final String
TAG_TASK_WORKER_SUSPEND
String
public static final String
TAG_TASK_WORKER_UPDATE
The @jc:task-update tag is used to annotate a JBCX method that update the task properties.
 

Method Summary

public void
archiveTasks()
Archive the tasks that are in the state aborted or completed
public String
createTask(TaskCreationXMLDocument doc)
Create and optionally assigns a new task using an XML interface
public void
purgeTasks()
Purge the tasks that are ready to be purged: completed or aborted time > purgDelay.

Field Detail

ATTR_ASSIGN_ALGORITHM

public static final String ATTR_ASSIGN_ALGORITHM


ATTR_ASSIGN_GROUP

public static final String ATTR_ASSIGN_GROUP


ATTR_ASSIGN_USER

public static final String ATTR_ASSIGN_USER


ATTR_CLAIM_CLAIMANT

public static final String ATTR_CLAIM_CLAIMANT


ATTR_CREATE_CAN_BE_ABORTED

public static final String ATTR_CREATE_CAN_BE_ABORTED


ATTR_CREATE_CAN_BE_REASSIGNED

public static final String ATTR_CREATE_CAN_BE_REASSIGNED


ATTR_CREATE_CAN_BE_RETURNED

public static final String ATTR_CREATE_CAN_BE_RETURNED


ATTR_CREATE_CLAIM_CALENDAR

public static final String ATTR_CREATE_CLAIM_CALENDAR


ATTR_CREATE_CLAIM_DUE_BUSINESS_DATE

public static final String ATTR_CREATE_CLAIM_DUE_BUSINESS_DATE


ATTR_CREATE_CLAIM_DUE_DATE

public static final String ATTR_CREATE_CLAIM_DUE_DATE


ATTR_CREATE_CLAIM_USER_CALENDAR

public static final String ATTR_CREATE_CLAIM_USER_CALENDAR


ATTR_CREATE_COMMENT

public static final String ATTR_CREATE_COMMENT


ATTR_CREATE_COMPLETION_CALENDAR

public static final String ATTR_CREATE_COMPLETION_CALENDAR


ATTR_CREATE_COMPLETION_DUE_BUSINESS_DATE

public static final String ATTR_CREATE_COMPLETION_DUE_BUSINESS_DATE


ATTR_CREATE_COMPLETION_DUE_DATE

public static final String ATTR_CREATE_COMPLETION_DUE_DATE


ATTR_CREATE_COMPLETION_USER_CALENDAR

public static final String ATTR_CREATE_COMPLETION_USER_CALENDAR


ATTR_CREATE_DESCRIPTION

public static final String ATTR_CREATE_DESCRIPTION


ATTR_CREATE_NAME

public static final String ATTR_CREATE_NAME


ATTR_CREATE_OWNER

public static final String ATTR_CREATE_OWNER


ATTR_CREATE_PRIORITY

public static final String ATTR_CREATE_PRIORITY


ATTR_CREATE_REQUEST

public static final String ATTR_CREATE_REQUEST


ATTR_CREATE_REQUEST_MIME_TYPE

public static final String ATTR_CREATE_REQUEST_MIME_TYPE


ATTR_GET_PROPERTY_NAME

public static final String ATTR_GET_PROPERTY_NAME


ATTR_REMOVE_PROPERTY_NAME

public static final String ATTR_REMOVE_PROPERTY_NAME


ATTR_SELECT_ASSIGNED_GROUP

public static final String ATTR_SELECT_ASSIGNED_GROUP


ATTR_SELECT_ASSIGNED_USER

public static final String ATTR_SELECT_ASSIGNED_USER


ATTR_SELECT_CLAIM_DUE_DATE_AFTER

public static final String ATTR_SELECT_CLAIM_DUE_DATE_AFTER


ATTR_SELECT_CLAIM_DUE_DATE_BEFORE

public static final String ATTR_SELECT_CLAIM_DUE_DATE_BEFORE


ATTR_SELECT_CLAIMANT

public static final String ATTR_SELECT_CLAIMANT


ATTR_SELECT_COMPLETION_DUE_DATE_AFTER

public static final String ATTR_SELECT_COMPLETION_DUE_DATE_AFTER


ATTR_SELECT_COMPLETION_DUE_DATE_BEFORE

public static final String ATTR_SELECT_COMPLETION_DUE_DATE_BEFORE


ATTR_SELECT_CREATION_DATE_AFTER

public static final String ATTR_SELECT_CREATION_DATE_AFTER


ATTR_SELECT_CREATION_DATE_BEFORE

public static final String ATTR_SELECT_CREATION_DATE_BEFORE


ATTR_SELECT_MAX_PRIORITY

public static final String ATTR_SELECT_MAX_PRIORITY


ATTR_SELECT_MIN_PRIORITY

public static final String ATTR_SELECT_MIN_PRIORITY


ATTR_SELECT_PROPERTY_NAME

public static final String ATTR_SELECT_PROPERTY_NAME


ATTR_SELECT_PROPERTY_VALUE

public static final String ATTR_SELECT_PROPERTY_VALUE


ATTR_SELECT_SELECTOR

public static final String ATTR_SELECT_SELECTOR


ATTR_SELECT_STATES

public static final String ATTR_SELECT_STATES


ATTR_SELECT_TASK_COMMENT

public static final String ATTR_SELECT_TASK_COMMENT


ATTR_SELECT_TASK_ID

public static final String ATTR_SELECT_TASK_ID


ATTR_SELECT_TASK_NAME

public static final String ATTR_SELECT_TASK_NAME


ATTR_SELECT_TASK_OWNER

public static final String ATTR_SELECT_TASK_OWNER


ATTR_SET_PROPERTY_NAME

public static final String ATTR_SET_PROPERTY_NAME


ATTR_SET_PROPERTY_VALUE

public static final String ATTR_SET_PROPERTY_VALUE


ATTR_UPDATE_CAN_BE_ABORTED

public static final String ATTR_UPDATE_CAN_BE_ABORTED


ATTR_UPDATE_CAN_BE_REASSIGNED

public static final String ATTR_UPDATE_CAN_BE_REASSIGNED


ATTR_UPDATE_CAN_BE_RETURNED

public static final String ATTR_UPDATE_CAN_BE_RETURNED


ATTR_UPDATE_CLAIM_CALENDAR

public static final String ATTR_UPDATE_CLAIM_CALENDAR


ATTR_UPDATE_CLAIM_DUE_BUSINESS_DATE

public static final String ATTR_UPDATE_CLAIM_DUE_BUSINESS_DATE


ATTR_UPDATE_CLAIM_DUE_DATE

public static final String ATTR_UPDATE_CLAIM_DUE_DATE


ATTR_UPDATE_CLAIM_USER_CALENDAR

public static final String ATTR_UPDATE_CLAIM_USER_CALENDAR


ATTR_UPDATE_COMMENT

public static final String ATTR_UPDATE_COMMENT


ATTR_UPDATE_COMPLETION_CALENDAR

public static final String ATTR_UPDATE_COMPLETION_CALENDAR


ATTR_UPDATE_COMPLETION_DUE_BUSINESS_DATE

public static final String ATTR_UPDATE_COMPLETION_DUE_BUSINESS_DATE


ATTR_UPDATE_COMPLETION_DUE_DATE

public static final String ATTR_UPDATE_COMPLETION_DUE_DATE


ATTR_UPDATE_COMPLETION_USER_CALENDAR

public static final String ATTR_UPDATE_COMPLETION_USER_CALENDAR


ATTR_UPDATE_OWNER

public static final String ATTR_UPDATE_OWNER


ATTR_UPDATE_PRIORITY

public static final String ATTR_UPDATE_PRIORITY


ATTR_UPDATE_REQUEST

public static final String ATTR_UPDATE_REQUEST


ATTR_UPDATE_REQUEST_MIME_TYPE

public static final String ATTR_UPDATE_REQUEST_MIME_TYPE


ATTR_UPDATE_RESPONSE

public static final String ATTR_UPDATE_RESPONSE


ATTR_UPDATE_RESPONSE_MIME_TYPE

public static final String ATTR_UPDATE_RESPONSE_MIME_TYPE


TAG_TASK_WORKER

public static final String TAG_TASK_WORKER
the control jc tag.


TAG_TASK_WORKER_ABORT

public static final String TAG_TASK_WORKER_ABORT


TAG_TASK_WORKER_ASSIGN

public static final String TAG_TASK_WORKER_ASSIGN
The @jc:task-assign tag is used to annotate a JBCX method that assign or reassign a task. The algorithm name is used to determine the way a task is assigned. If no name is pecified the default algorithm is used and the args must be of type String[]; In any case the attribute "args" is required and must be of type Object[].


TAG_TASK_WORKER_CLAIM

public static final String TAG_TASK_WORKER_CLAIM


TAG_TASK_WORKER_COMPLETE

public static final String TAG_TASK_WORKER_COMPLETE


TAG_TASK_WORKER_CREATE

public static final String TAG_TASK_WORKER_CREATE
The @jc:create tag is used to annotate a JBCX method that creates a new task. This method returns the taskId of the created task.


TAG_TASK_WORKER_DELETE

public static final String TAG_TASK_WORKER_DELETE


TAG_TASK_WORKER_GET_INFO

public static final String TAG_TASK_WORKER_GET_INFO
The return type of the method JBCX is used to determine what is returned: TaskInfo[] TaskInfoXML[]


TAG_TASK_WORKER_GET_PROPERTY

public static final String TAG_TASK_WORKER_GET_PROPERTY


TAG_TASK_WORKER_GET_PROPERTY_NAME

public static final String TAG_TASK_WORKER_GET_PROPERTY_NAME


TAG_TASK_WORKER_GET_REQUEST

public static final String TAG_TASK_WORKER_GET_REQUEST
The return type of the method JBCX is used to determine what is returned.


TAG_TASK_WORKER_GET_RESPONSE

public static final String TAG_TASK_WORKER_GET_RESPONSE
The return type of the method JBCX is used to determine what is returned.


TAG_TASK_WORKER_REMOVE_PROPERTY

public static final String TAG_TASK_WORKER_REMOVE_PROPERTY


TAG_TASK_WORKER_RESUME

public static final String TAG_TASK_WORKER_RESUME


TAG_TASK_WORKER_RETURN

public static final String TAG_TASK_WORKER_RETURN


TAG_TASK_WORKER_SELECT

public static final String TAG_TASK_WORKER_SELECT
The @jc:task-select tag is used in correlation with the other method tags of this control. It is used to determine the tasks concerned by the operation.


TAG_TASK_WORKER_SET_PROPERTY

public static final String TAG_TASK_WORKER_SET_PROPERTY


TAG_TASK_WORKER_START

public static final String TAG_TASK_WORKER_START


TAG_TASK_WORKER_STOP

public static final String TAG_TASK_WORKER_STOP


TAG_TASK_WORKER_SUSPEND

public static final String TAG_TASK_WORKER_SUSPEND


TAG_TASK_WORKER_UPDATE

public static final String TAG_TASK_WORKER_UPDATE
The @jc:task-update tag is used to annotate a JBCX method that update the task properties. You can modify one or more properties at the same time.

 

Method Detail

archiveTasks() Method

public void archiveTasks()
Archive the tasks that are in the state aborted or completed


createTask(TaskCreationXMLDocument) Method

public String createTask(TaskCreationXMLDocument doc)
Create and optionally assigns a new task using an XML interface

Parameters

doc
the task parameters

Returns

the taskId

purgeTasks() Method

public void purgeTasks()
Purge the tasks that are ready to be purged: completed or aborted time > purgDelay. if archiver is on the task must be archived first.