com.ibm.task.api
Interface WorkItem

All Superinterfaces:
java.io.Serializable

public interface WorkItem
extends java.io.Serializable

Accesses the properties of a work item.

A work item represents a relationship between a person or group of persons and an object, typically an activity or task instance. The relationship is described by attributes such as the type of the associated object and the reason why the object is assigned.

Work items are created whenever a staff, receive, or pick activity is encountered during the navigation of a process instance. The associated staff resolution plug-in is invoked and returns a list of persons. Each person on the list receives a work item for the activity instance. Work items are also created for the starter, process administrators, editors, and readers of a process instance.

Since:
5.0

Field Summary
static java.lang.String COPYRIGHT
           
static int OBJECT_TYPE_ACTIVITY
          States that the work item has been created for an activity.
static int OBJECT_TYPE_APPLICATION_COMPONENT
          For future use.
static int OBJECT_TYPE_ESCALATION_INSTANCE
          For future use.
static int OBJECT_TYPE_ESCALATION_TEMPLATE
          For future use.
static int OBJECT_TYPE_EVENT
          States that the work item has been created for a receive event.
static int OBJECT_TYPE_MAX
          For future use.
static int OBJECT_TYPE_PROCESS_INSTANCE
          States that the work item has been created for a process instance.
static int OBJECT_TYPE_PROCESS_TEMPLATE
          For future use.
static int OBJECT_TYPE_STATE_MACHINE_EVENT
          For future use.
static int OBJECT_TYPE_STATE_MACHINE_INSTANCE
          For future use.
static int OBJECT_TYPE_STATE_MACHINE_TEMPLATE
          For future use.
static int OBJECT_TYPE_TASK_INSTANCE
          For future use.
static int OBJECT_TYPE_TASK_TEMPLATE
          For future use.
static int REASON_ADMINISTRATOR
          States that operations can be executed on the associated object that require process administrator rights, for example, deletion of a process instance.
static int REASON_EDITOR
          States that operations can be executed on the associated object that require Editor authority, for example, setting the output message of an activity.
static int REASON_ESCALATION_RECEIVER
          States that operations can be executed on the associated object that require escalation receiver rights, for example, reading properties of the task that is escalated.
static int REASON_MAX
          For future use.
static int REASON_ORIGINATOR
          States that operations can be executed on the associated object that require originator rights, for example, deletion of a task instance.
static int REASON_OWNER
          States that the associated object can be completed.
static int REASON_POTENTIAL_INSTANCE_CREATOR
          States that operations can be executed on the associated object that require instance creatorr rights, for example, creating tasks derived from a task template.
static int REASON_POTENTIAL_OWNER
          States that the associated object can be claimed.
static int REASON_POTENTIAL_SENDER
          For future use.
static int REASON_POTENTIAL_STARTER
          For future use.
static int REASON_READER
          States that operations can be executed on the associated object that require Reader authority, for example, reading the properties of an activity instance.
static int REASON_STARTER
          States that operations can be executed on the associated object that require Starter authority, for example, setting a customer attribute of a process instance.
static int REASON_STATE_MACHINE_END
          For future use.
static int REASON_STATE_MACHINE_EVENT_AVAILABLE
          For future use.
static int REASON_STATE_MACHINE_START
          For future use.
 
Method Summary
 int getAssignmentReason()
          Returns the reason why the work item is assigned.
 int getAssociatedObjectType()
          Returns the type of the object associated to or containing the work item's associated object.
 com.ibm.bpe.api.OID getAssociatedOid()
          Returns the object ID of the object associated to or containing the work item's associated object.
 java.util.Calendar getCreationTime()
          Returns the creation time of the work item.
 com.ibm.bpe.api.WIID getID()
          Returns the object identifier.
 boolean getIsAssignedToEverybody()
          Returns whether the workitem is assigned to everybody.
 com.ibm.bpe.api.OID getObjectID()
          Returns the object ID of the associated object.
 int getObjectType()
          Returns the type of the associated object.
 java.lang.String getOwnerID()
          Returns the principal ID of the workitem owner if the work item is not assigned to everybody.
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
See Also:
Constant Field Values

OBJECT_TYPE_STATE_MACHINE_TEMPLATE

public static final int OBJECT_TYPE_STATE_MACHINE_TEMPLATE
For future use.

See Also:
Constant Field Values

OBJECT_TYPE_TASK_INSTANCE

public static final int OBJECT_TYPE_TASK_INSTANCE
For future use.

See Also:
Constant Field Values

OBJECT_TYPE_TASK_TEMPLATE

public static final int OBJECT_TYPE_TASK_TEMPLATE
For future use.

See Also:
Constant Field Values

OBJECT_TYPE_STATE_MACHINE_EVENT

public static final int OBJECT_TYPE_STATE_MACHINE_EVENT
For future use.

See Also:
Constant Field Values

OBJECT_TYPE_MAX

public static final int OBJECT_TYPE_MAX
For future use.

See Also:
Constant Field Values

OBJECT_TYPE_ESCALATION_TEMPLATE

public static final int OBJECT_TYPE_ESCALATION_TEMPLATE
For future use.

See Also:
Constant Field Values

OBJECT_TYPE_PROCESS_TEMPLATE

public static final int OBJECT_TYPE_PROCESS_TEMPLATE
For future use.

See Also:
Constant Field Values

OBJECT_TYPE_EVENT

public static final int OBJECT_TYPE_EVENT
States that the work item has been created for a receive event.

See Also:
Constant Field Values

OBJECT_TYPE_APPLICATION_COMPONENT

public static final int OBJECT_TYPE_APPLICATION_COMPONENT
For future use.

See Also:
Constant Field Values

OBJECT_TYPE_ESCALATION_INSTANCE

public static final int OBJECT_TYPE_ESCALATION_INSTANCE
For future use.

See Also:
Constant Field Values

OBJECT_TYPE_PROCESS_INSTANCE

public static final int OBJECT_TYPE_PROCESS_INSTANCE
States that the work item has been created for a process instance.

See Also:
Constant Field Values

OBJECT_TYPE_ACTIVITY

public static final int OBJECT_TYPE_ACTIVITY
States that the work item has been created for an activity.

See Also:
Constant Field Values

OBJECT_TYPE_STATE_MACHINE_INSTANCE

public static final int OBJECT_TYPE_STATE_MACHINE_INSTANCE
For future use.

See Also:
Constant Field Values

REASON_POTENTIAL_STARTER

public static final int REASON_POTENTIAL_STARTER
For future use.

See Also:
Constant Field Values

REASON_ESCALATION_RECEIVER

public static final int REASON_ESCALATION_RECEIVER
States that operations can be executed on the associated object that require escalation receiver rights, for example, reading properties of the task that is escalated.

See Also:
Constant Field Values

REASON_EDITOR

public static final int REASON_EDITOR
States that operations can be executed on the associated object that require Editor authority, for example, setting the output message of an activity.

See Also:
Constant Field Values

REASON_OWNER

public static final int REASON_OWNER
States that the associated object can be completed.

See Also:
Constant Field Values

REASON_ADMINISTRATOR

public static final int REASON_ADMINISTRATOR
States that operations can be executed on the associated object that require process administrator rights, for example, deletion of a process instance.

See Also:
Constant Field Values

REASON_POTENTIAL_INSTANCE_CREATOR

public static final int REASON_POTENTIAL_INSTANCE_CREATOR
States that operations can be executed on the associated object that require instance creatorr rights, for example, creating tasks derived from a task template.

See Also:
Constant Field Values

REASON_READER

public static final int REASON_READER
States that operations can be executed on the associated object that require Reader authority, for example, reading the properties of an activity instance.

See Also:
Constant Field Values

REASON_POTENTIAL_SENDER

public static final int REASON_POTENTIAL_SENDER
For future use.

See Also:
Constant Field Values

REASON_MAX

public static final int REASON_MAX
For future use.

See Also:
Constant Field Values

REASON_POTENTIAL_OWNER

public static final int REASON_POTENTIAL_OWNER
States that the associated object can be claimed.

See Also:
Constant Field Values

REASON_STATE_MACHINE_START

public static final int REASON_STATE_MACHINE_START
For future use.

See Also:
Constant Field Values

REASON_STARTER

public static final int REASON_STARTER
States that operations can be executed on the associated object that require Starter authority, for example, setting a customer attribute of a process instance.

See Also:
Constant Field Values

REASON_ORIGINATOR

public static final int REASON_ORIGINATOR
States that operations can be executed on the associated object that require originator rights, for example, deletion of a task instance.

See Also:
Constant Field Values

REASON_STATE_MACHINE_END

public static final int REASON_STATE_MACHINE_END
For future use.

See Also:
Constant Field Values

REASON_STATE_MACHINE_EVENT_AVAILABLE

public static final int REASON_STATE_MACHINE_EVENT_AVAILABLE
For future use.

See Also:
Constant Field Values
Method Detail

getID

public com.ibm.bpe.api.WIID getID()
Returns the object identifier.


getOwnerID

public java.lang.String getOwnerID()
Returns the principal ID of the workitem owner if the work item is not assigned to everybody.


getIsAssignedToEverybody

public boolean getIsAssignedToEverybody()
Returns whether the workitem is assigned to everybody. If assigned to everybody, the owner ID is a null string.


getObjectType

public int getObjectType()
Returns the type of the associated object. Possible values are: OBJECT_TYPE_ACTIVITY, OBJECT_TYPE_PROCESS_INSTANCE, OBJECT_TYPE_EVENT.


getObjectID

public com.ibm.bpe.api.OID getObjectID()
Returns the object ID of the associated object.


getAssociatedObjectType

public int getAssociatedObjectType()
Returns the type of the object associated to or containing the work item's associated object. Possible values are: OBJECT_TYPE_ACTIVITY, OBJECT_TYPE_PROCESS_INSTANCE, OBJECT_TYPE_EVENT.


getAssociatedOid

public com.ibm.bpe.api.OID getAssociatedOid()
Returns the object ID of the object associated to or containing the work item's associated object. For example, the PIID of the process instance containing the activity instance for which this work item has been created.


getAssignmentReason

public int getAssignmentReason()
Returns the reason why the work item is assigned. Possible reasons are: REASON_POTENTIAL_OWNER, REASON_EDITOR, REASON_READER, REASON_OWNER, REASON_STARTER, REASON_ADMINISTRATOR, REASON_ORIGINATOR, REASON_ESCALATION_RECEIVER, REASON_POTENTIAL_INSTANCE_CREATOR.


getCreationTime

public java.util.Calendar getCreationTime()
Returns the creation time of the work item.