com.ibm.task.api
Interface WorkItem
- public interface WorkItem
- extends java.io.Serializable
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.
For example, work items are created whenever a human task (staff), receive, or pick activity is encountered during the navigation of a process instance. The associated people assignment is performed and returns a list or group of persons. Each person on the list or the group receives a work item for the activity instance. Similarly, work items are created for the starter, process administrators, editors, and readers of a process instance.
Beginning with Version 7.0.0.3, shared work items are used for authorization instead of non-shared work items. To benefit from the performance benefits of shared work items, do not use the deprecated methods.
Field Summary
Modifier and Type | Field and Description |
---|---|
|
COPYRIGHT
|
|
OBJECT_TYPE_ACTIVITY
States that the work item has been created for an activity instance.
|
|
OBJECT_TYPE_APPLICATION_COMPONENT
Do not use - internal only.
|
|
OBJECT_TYPE_BUSINESS_CATEGORY
States that the work item has been created for a business category.
|
|
OBJECT_TYPE_ESCALATION_INSTANCE
States that the work item has been created for an escalation instance.
|
|
OBJECT_TYPE_ESCALATION_TEMPLATE
Do not use - internal only.
|
|
OBJECT_TYPE_EVENT
States that the work item has been created for a receive event.
|
|
OBJECT_TYPE_MAX
Do not use - internal only.
|
|
OBJECT_TYPE_PROCESS_INSTANCE
States that the work item has been created for a process instance.
|
|
OBJECT_TYPE_PROCESS_TEMPLATE
Do not use - internal only.
|
|
OBJECT_TYPE_STATE_MACHINE_EVENT
Do not use - internal only.
|
|
OBJECT_TYPE_STATE_MACHINE_INSTANCE
Do not use - internal only.
|
|
OBJECT_TYPE_STATE_MACHINE_TEMPLATE
Do not use - internal only.
|
|
OBJECT_TYPE_TASK_INSTANCE
States that the work item has been created for a task instance.
|
|
OBJECT_TYPE_TASK_TEMPLATE
Do not use - internal only.
|
|
OBJECT_TYPE_WORK_BASKET
States that the work item has been created for a work basket.
|
|
REASON_ADMINISTRATOR
States that operations can be executed on the associated object that require
administrator rights, for example, deletion of an object.
|
|
REASON_APPENDER
States that operations can be executed on the associated object that require
appender rights.
|
|
REASON_CUSTOMROLE_1
States that operations can be executed on the associated object that require
rights defined by custom role 1.
|
|
REASON_CUSTOMROLE_10
States that operations can be executed on the associated object that require
rights defined by custom role 10.
|
|
REASON_CUSTOMROLE_11
States that operations can be executed on the associated object that require
rights defined by custom role 11.
|
|
REASON_CUSTOMROLE_12
States that operations can be executed on the associated object that require
rights defined by custom role 12.
|
|
REASON_CUSTOMROLE_13
States that operations can be executed on the associated object that require
rights defined by custom role 13.
|
|
REASON_CUSTOMROLE_14
States that operations can be executed on the associated object that require
rights defined by custom role 14.
|
|
REASON_CUSTOMROLE_15
States that operations can be executed on the associated object that require
rights defined by custom role 15.
|
|
REASON_CUSTOMROLE_16
States that operations can be executed on the associated object that require
rights defined by custom role 16.
|
|
REASON_CUSTOMROLE_17
States that operations can be executed on the associated object that require
rights defined by custom role 17.
|
|
REASON_CUSTOMROLE_18
States that operations can be executed on the associated object that require
rights defined by custom role 18.
|
|
REASON_CUSTOMROLE_19
States that operations can be executed on the associated object that require
rights defined by custom role 19.
|
|
REASON_CUSTOMROLE_2
States that operations can be executed on the associated object that require
rights defined by custom role 2.
|
|
REASON_CUSTOMROLE_20
States that operations can be executed on the associated object that require
rights defined by custom role 20.
|
|
REASON_CUSTOMROLE_3
States that operations can be executed on the associated object that require
rights defined by custom role 3.
|
|
REASON_CUSTOMROLE_4
States that operations can be executed on the associated object that require
rights defined by custom role 4.
|
|
REASON_CUSTOMROLE_5
States that operations can be executed on the associated object that require
rights defined by custom role 5.
|
|
REASON_CUSTOMROLE_6
States that operations can be executed on the associated object that require
rights defined by custom role 6.
|
|
REASON_CUSTOMROLE_7
States that operations can be executed on the associated object that require
rights defined by custom role 7.
|
|
REASON_CUSTOMROLE_8
States that operations can be executed on the associated object that require
rights defined by custom role 8.
|
|
REASON_CUSTOMROLE_9
States that operations can be executed on the associated object that require
rights defined by custom role 9.
|
|
REASON_DISTRIBUTOR
States that operations can be executed on the associated object that require
distributor rights, for example, distributing objects to a work basket.
|
|
REASON_EDITOR
States that operations can be executed on the associated object that require
editor authority, for example, setting the output message of an object.
|
|
REASON_ESCALATION_RECEIVER
States that operations can be executed on the associated object that require
escalation receiver rights, for example, reading properties of an object that is escalated.
|
|
REASON_INHERITANCE_ADMINISTRATOR
States that operations can be executed on the associated object that require
administrator rights.
|
|
REASON_INHERITANCE_EDITOR
States that operations can be executed on the associated object that require
editor rights.
|
|
REASON_INHERITANCE_POTENTIAL_OWNER
States that operations can be executed on the associated object that require
potential owner rights.
|
|
REASON_INHERITANCE_READER
States that operations can be executed on the associated object that require
reader rights.
|
|
REASON_MAX
Do not use -internal only.
|
|
REASON_NONE
For the Post Processor Plugin.
|
|
REASON_OPENER
States that operations can be executed on the associated object that require
opener rights.
|
|
REASON_ORIGINATOR
States that operations can be executed on the associated object that require
originator rights.
|
|
REASON_OWNER
States that the associated object can be completed.
|
|
REASON_POTENTIAL_INSTANCE_CREATOR
States that operations can be executed on the associated object that require
instance creator rights, for example, creating objects.
|
|
REASON_POTENTIAL_OWNER
States that the associated object can be claimed.
|
|
REASON_POTENTIAL_SENDER
Deprecated. Not used.
|
|
REASON_POTENTIAL_STARTER
States that operations can be executed on the associated object that require
potential starter rights, for example, creating objects.
|
|
REASON_READER
States that operations can be executed on the associated object that require
reader authority, for example, reading the properties of an object.
|
|
REASON_STARTER
States that operations can be executed on the associated object that require
starter authority.
|
|
REASON_STATE_MACHINE_END
Do not use -internal only.
|
|
REASON_STATE_MACHINE_EVENT_AVAILABLE
Do not use -internal only.
|
|
REASON_STATE_MACHINE_START
Do not use -internal only.
|
|
REASON_TRANSFER_INITIATOR
States that operations can be executed on the associated object that require
transfer initiator rights, for example, transferring objects into a work basket.
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
getAssignmentReason()
Returns the reason why the work item is assigned.
|
|
getAssociatedObjectType()
Deprecated. As of version 7.0,0.3, obsolete for shared work items.
|
getAssociatedOid()
Deprecated. As of version 7.0,0.3, obsolete for shared work items.
|
|
|
getCreationTime()
Deprecated. As of version 7.0,0.3, obsolete for shared work items.
|
|
getGroupName()
Returns the name of the group of persons associated with the work item.
|
|
getID()
Deprecated. As of version 7.0,0.3, obsolete for shared work items.
|
|
getIsAssignedToEverybody()
Returns whether the workitem is assigned to everybody.
|
getObjectID()
Deprecated. As of version 7.0,0.3, obsolete for shared work items.
|
|
|
getObjectType()
Deprecated. As of version 7.0,0.3, obsolete for shared work items.
|
|
getOwnerID()
Returns the user ID of the workitem owner if the
work item is not assigned to everybody or to a group of persons.
|
Field Detail
COPYRIGHT
- static final java.lang.String COPYRIGHT
OBJECT_TYPE_STATE_MACHINE_INSTANCE
- static final int OBJECT_TYPE_STATE_MACHINE_INSTANCE
OBJECT_TYPE_STATE_MACHINE_TEMPLATE
- static final int OBJECT_TYPE_STATE_MACHINE_TEMPLATE
OBJECT_TYPE_APPLICATION_COMPONENT
- static final int OBJECT_TYPE_APPLICATION_COMPONENT
OBJECT_TYPE_PROCESS_INSTANCE
- static final int OBJECT_TYPE_PROCESS_INSTANCE
OBJECT_TYPE_TASK_INSTANCE
- static final int OBJECT_TYPE_TASK_INSTANCE
OBJECT_TYPE_STATE_MACHINE_EVENT
- static final int OBJECT_TYPE_STATE_MACHINE_EVENT
OBJECT_TYPE_PROCESS_TEMPLATE
- static final int OBJECT_TYPE_PROCESS_TEMPLATE
OBJECT_TYPE_TASK_TEMPLATE
- static final int OBJECT_TYPE_TASK_TEMPLATE
OBJECT_TYPE_WORK_BASKET
- static final int OBJECT_TYPE_WORK_BASKET
OBJECT_TYPE_ACTIVITY
- static final int OBJECT_TYPE_ACTIVITY
OBJECT_TYPE_EVENT
- static final int OBJECT_TYPE_EVENT
OBJECT_TYPE_BUSINESS_CATEGORY
- static final int OBJECT_TYPE_BUSINESS_CATEGORY
OBJECT_TYPE_ESCALATION_INSTANCE
- static final int OBJECT_TYPE_ESCALATION_INSTANCE
OBJECT_TYPE_MAX
- static final int OBJECT_TYPE_MAX
OBJECT_TYPE_ESCALATION_TEMPLATE
- static final int OBJECT_TYPE_ESCALATION_TEMPLATE
REASON_CUSTOMROLE_14
- static final int REASON_CUSTOMROLE_14
REASON_CUSTOMROLE_15
- static final int REASON_CUSTOMROLE_15
REASON_CUSTOMROLE_16
- static final int REASON_CUSTOMROLE_16
REASON_INHERITANCE_POTENTIAL_OWNER
- static final int REASON_INHERITANCE_POTENTIAL_OWNER
REASON_STATE_MACHINE_EVENT_AVAILABLE
- static final int REASON_STATE_MACHINE_EVENT_AVAILABLE
REASON_CUSTOMROLE_17
- static final int REASON_CUSTOMROLE_17
REASON_CUSTOMROLE_18
- static final int REASON_CUSTOMROLE_18
REASON_CUSTOMROLE_19
- static final int REASON_CUSTOMROLE_19
REASON_EDITOR
- static final int REASON_EDITOR
REASON_MAX
- static final int REASON_MAX
REASON_DISTRIBUTOR
- static final int REASON_DISTRIBUTOR
REASON_OPENER
- static final int REASON_OPENER
REASON_INHERITANCE_READER
- static final int REASON_INHERITANCE_READER
REASON_TRANSFER_INITIATOR
- static final int REASON_TRANSFER_INITIATOR
REASON_ORIGINATOR
- static final int REASON_ORIGINATOR
REASON_POTENTIAL_OWNER
- static final int REASON_POTENTIAL_OWNER
REASON_OWNER
- static final int REASON_OWNER
REASON_STATE_MACHINE_END
- static final int REASON_STATE_MACHINE_END
REASON_CUSTOMROLE_20
- static final int REASON_CUSTOMROLE_20
REASON_INHERITANCE_ADMINISTRATOR
- static final int REASON_INHERITANCE_ADMINISTRATOR
REASON_POTENTIAL_INSTANCE_CREATOR
- static final int REASON_POTENTIAL_INSTANCE_CREATOR
REASON_ESCALATION_RECEIVER
- static final int REASON_ESCALATION_RECEIVER
REASON_READER
- static final int REASON_READER
REASON_STATE_MACHINE_START
- static final int REASON_STATE_MACHINE_START
REASON_APPENDER
- static final int REASON_APPENDER
REASON_POTENTIAL_SENDER
- static final int REASON_POTENTIAL_SENDER
REASON_ADMINISTRATOR
- static final int REASON_ADMINISTRATOR
REASON_POTENTIAL_STARTER
- static final int REASON_POTENTIAL_STARTER
REASON_STARTER
- static final int REASON_STARTER
REASON_CUSTOMROLE_1
- static final int REASON_CUSTOMROLE_1
REASON_CUSTOMROLE_2
- static final int REASON_CUSTOMROLE_2
REASON_CUSTOMROLE_3
- static final int REASON_CUSTOMROLE_3
REASON_CUSTOMROLE_4
- static final int REASON_CUSTOMROLE_4
REASON_CUSTOMROLE_5
- static final int REASON_CUSTOMROLE_5
REASON_CUSTOMROLE_6
- static final int REASON_CUSTOMROLE_6
REASON_CUSTOMROLE_7
- static final int REASON_CUSTOMROLE_7
REASON_CUSTOMROLE_8
- static final int REASON_CUSTOMROLE_8
REASON_CUSTOMROLE_10
- static final int REASON_CUSTOMROLE_10
REASON_CUSTOMROLE_9
- static final int REASON_CUSTOMROLE_9
REASON_CUSTOMROLE_11
- static final int REASON_CUSTOMROLE_11
REASON_INHERITANCE_EDITOR
- static final int REASON_INHERITANCE_EDITOR
REASON_CUSTOMROLE_12
- static final int REASON_CUSTOMROLE_12
REASON_CUSTOMROLE_13
- static final int REASON_CUSTOMROLE_13
REASON_NONE
- static final int REASON_NONE
Method Detail
getID
- com.ibm.bpe.api.WIID getID()
getOwnerID
- java.lang.String getOwnerID()
getIsAssignedToEverybody
- boolean getIsAssignedToEverybody( )
getObjectType
- int getObjectType()
getObjectID
- OID getObjectID()
getAssociatedObjectType
- int getAssociatedObjectType()
getAssociatedOid
- OID getAssociatedOid()
getAssignmentReason
- int getAssignmentReason()
getCreationTime
- java.util.Calendar getCreationTime( )
getGroupName
- java.lang.String getGroupName()