# com.bea.control
TaskControl Interface

public interface TaskControl
extends `Control`

The Task control enables a business process to create a single Task instance, manage its state and data, and provide callback methods that report status. Each Task control operates on a single active Task instance. You can extend this control.

All Superinterfaces
  `Control`, `Control`, `Serializable`

## Nested Class Summary

`public static interface` | `TaskControl.Callback`

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_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_SET_PROPERTY_MAP` 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 `Integer`` | `CALENDAR_TYPE_NAME` Integer
`public static final `Integer`` | `CALENDAR_TYPE_SYSTEM` Integer
`public static final `Integer`` | `CALENDAR_TYPE_USER_OR_GROUP` Integer
`public static final `String`` | `TAG_ADVANCED` the control advanced options jc tag.
`public static final `String`` | `TAG_ASSIGNEE` the control assignement jc tag.
`public static final `String`` | `TAG_TASK` the control jc tag.
`public static final `String`` | `TAG_TASK_ABORT` String
`public static final `String`` | `TAG_TASK_ASSIGN` The @jc:create tag is used to annotate a JBCX method that assign or reassign a task.
`public static final `String`` | `TAG_TASK_CREATE` The @jc:create tag is used to annotate a JBCX method that creates a new task.
`public static final `String`` | `TAG_TASK_GET_PROPERTY` The return type of the method JBCX is used to determine what is returned.
`public static final `String`` | `TAG_TASK_GET_REQUEST` The return type of the method JBCX is used to determine what is returned.
`public static final `String`` | `TAG_TASK_GET_RESPONSE` The return type of the method JBCX is used to determine what is returned.
`public static final `String`` | `TAG_TASK_REMOVE_PROPERTY` String
`public static final `String`` | `TAG_TASK_RESUME` String
`public static final `String`` | `TAG_TASK_SET_PROPERTY` String
`public static final `String`` | `TAG_TASK_SUSPEND` String
`public static final `String`` | `TAG_TASK_UPDATE` The @jc:task-update tag is used to annotate a JBCX method that update the task properties.

## Method Summary

`public `String`` | `createTask`(`TaskCreationXMLDocument` doc) Create and optionally assigns a new task using an XML interface
`public `String`` | `getTaskId`()
`public `TaskInfo`` | `getTaskInfo`()
`public `TaskInfoXMLDocument`` | `getTaskInfoXMLDocument`()
`public `String`[]` | `getTaskPropertiesNames`()
`public void` | `setTaskId`(`String` taskId) Set the TaskId the control is linked to.
`public void` | `updateTask`(`TaskUpdateXMLDocument` doc)

## 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_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_SET_PROPERTY_MAP

    public static final String ATTR_SET_PROPERTY_MAP

### 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

### CALENDAR_TYPE_NAME

    public static final Integer CALENDAR_TYPE_NAME

### CALENDAR_TYPE_SYSTEM

    public static final Integer CALENDAR_TYPE_SYSTEM

### CALENDAR_TYPE_USER_OR_GROUP

    public static final Integer CALENDAR_TYPE_USER_OR_GROUP

### TAG_ADVANCED

    public static final String TAG_ADVANCED

  the control advanced options jc tag.

### TAG_ASSIGNEE

    public static final String TAG_ASSIGNEE

  the control assignement jc tag.

### TAG_TASK

    public static final String TAG_TASK

  the control jc tag.

### TAG_TASK_ABORT

    public static final String TAG_TASK_ABORT

### TAG_TASK_ASSIGN

    public static final String TAG_TASK_ASSIGN

  The @jc:create 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_CREATE

    public static final String TAG_TASK_CREATE

  The @jc:create tag is used to annotate a JBCX method that creates a new task. This method can at most be called once by control and returns the taskId. The callbacks are registered to the new task created

### TAG_TASK_GET_PROPERTY

    public static final String TAG_TASK_GET_PROPERTY

  The return type of the method JBCX is used to determine what is returned.

### TAG_TASK_GET_REQUEST

    public static final String TAG_TASK_GET_REQUEST

  The return type of the method JBCX is used to determine what is returned.

### TAG_TASK_GET_RESPONSE

    public static final String TAG_TASK_GET_RESPONSE

  The return type of the method JBCX is used to determine what is returned.

### TAG_TASK_REMOVE_PROPERTY

    public static final String TAG_TASK_REMOVE_PROPERTY

### TAG_TASK_RESUME

    public static final String TAG_TASK_RESUME

### TAG_TASK_SET_PROPERTY

    public static final String TAG_TASK_SET_PROPERTY

### TAG_TASK_SUSPEND

    public static final String TAG_TASK_SUSPEND

### TAG_TASK_UPDATE

    public static final String TAG_TASK_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

### 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

### getTaskId() Method

    public String getTaskId()

### getTaskInfo() Method

    public TaskInfo getTaskInfo()

### getTaskInfoXMLDocument() Method

    public TaskInfoXMLDocument getTaskInfoXMLDocument()

### getTaskPropertiesNames() Method

    public String[] getTaskPropertiesNames()

### setTaskId(String) Method

    public void setTaskId(String taskId)

Set the TaskId the control is linked to. The taskId can only be set once. When a task is created, its taskId is set to the control if no taskId has been set before or return an exception otherwise. If you want to work with more than one taskId you can use multiple control or the WorklistControl.

### updateTask(TaskUpdateXMLDocument) Method

    public void updateTask(TaskUpdateXMLDocument doc)