com.ibm.task.api

Interface WorkItem

All Superinterfaces:
java.io.Serializable

  1. public interface WorkItem
  2. 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.

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.

Since:
5.0

Field Summary

Modifier and Type Field and Description
  1. static
  2. java.lang.String
COPYRIGHT
  1. static
  2. int
OBJECT_TYPE_ACTIVITY
States that the work item has been created for an activity instance.
  1. static
  2. int
OBJECT_TYPE_APPLICATION_COMPONENT
Do not use - internal only.
  1. static
  2. int
OBJECT_TYPE_BUSINESS_CATEGORY
States that the work item has been created for a business category.
  1. static
  2. int
OBJECT_TYPE_ESCALATION_INSTANCE
States that the work item has been created for an escalation instance.
  1. static
  2. int
OBJECT_TYPE_ESCALATION_TEMPLATE
Do not use - internal only.
  1. static
  2. int
OBJECT_TYPE_EVENT
States that the work item has been created for a receive event.
  1. static
  2. int
OBJECT_TYPE_MAX
Do not use - internal only.
  1. static
  2. int
OBJECT_TYPE_PROCESS_INSTANCE
States that the work item has been created for a process instance.
  1. static
  2. int
OBJECT_TYPE_PROCESS_TEMPLATE
Do not use - internal only.
  1. static
  2. int
OBJECT_TYPE_STATE_MACHINE_EVENT
Do not use - internal only.
  1. static
  2. int
OBJECT_TYPE_STATE_MACHINE_INSTANCE
Do not use - internal only.
  1. static
  2. int
OBJECT_TYPE_STATE_MACHINE_TEMPLATE
Do not use - internal only.
  1. static
  2. int
OBJECT_TYPE_TASK_INSTANCE
States that the work item has been created for a task instance.
  1. static
  2. int
OBJECT_TYPE_TASK_TEMPLATE
Do not use - internal only.
  1. static
  2. int
OBJECT_TYPE_WORK_BASKET
States that the work item has been created for a work basket.
  1. static
  2. int
REASON_ADMINISTRATOR
States that operations can be executed on the associated object that require administrator rights, for example, deletion of an object.
  1. static
  2. int
REASON_APPENDER
States that operations can be executed on the associated object that require appender rights.
  1. static
  2. int
REASON_CUSTOMROLE_1
States that operations can be executed on the associated object that require rights defined by custom role 1.
  1. static
  2. int
REASON_CUSTOMROLE_10
States that operations can be executed on the associated object that require rights defined by custom role 10.
  1. static
  2. int
REASON_CUSTOMROLE_11
States that operations can be executed on the associated object that require rights defined by custom role 11.
  1. static
  2. int
REASON_CUSTOMROLE_12
States that operations can be executed on the associated object that require rights defined by custom role 12.
  1. static
  2. int
REASON_CUSTOMROLE_13
States that operations can be executed on the associated object that require rights defined by custom role 13.
  1. static
  2. int
REASON_CUSTOMROLE_14
States that operations can be executed on the associated object that require rights defined by custom role 14.
  1. static
  2. int
REASON_CUSTOMROLE_15
States that operations can be executed on the associated object that require rights defined by custom role 15.
  1. static
  2. int
REASON_CUSTOMROLE_16
States that operations can be executed on the associated object that require rights defined by custom role 16.
  1. static
  2. int
REASON_CUSTOMROLE_17
States that operations can be executed on the associated object that require rights defined by custom role 17.
  1. static
  2. int
REASON_CUSTOMROLE_18
States that operations can be executed on the associated object that require rights defined by custom role 18.
  1. static
  2. int
REASON_CUSTOMROLE_19
States that operations can be executed on the associated object that require rights defined by custom role 19.
  1. static
  2. int
REASON_CUSTOMROLE_2
States that operations can be executed on the associated object that require rights defined by custom role 2.
  1. static
  2. int
REASON_CUSTOMROLE_20
States that operations can be executed on the associated object that require rights defined by custom role 20.
  1. static
  2. int
REASON_CUSTOMROLE_3
States that operations can be executed on the associated object that require rights defined by custom role 3.
  1. static
  2. int
REASON_CUSTOMROLE_4
States that operations can be executed on the associated object that require rights defined by custom role 4.
  1. static
  2. int
REASON_CUSTOMROLE_5
States that operations can be executed on the associated object that require rights defined by custom role 5.
  1. static
  2. int
REASON_CUSTOMROLE_6
States that operations can be executed on the associated object that require rights defined by custom role 6.
  1. static
  2. int
REASON_CUSTOMROLE_7
States that operations can be executed on the associated object that require rights defined by custom role 7.
  1. static
  2. int
REASON_CUSTOMROLE_8
States that operations can be executed on the associated object that require rights defined by custom role 8.
  1. static
  2. int
REASON_CUSTOMROLE_9
States that operations can be executed on the associated object that require rights defined by custom role 9.
  1. static
  2. int
REASON_DISTRIBUTOR
States that operations can be executed on the associated object that require distributor rights, for example, distributing objects to a work basket.
  1. static
  2. 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 object.
  1. static
  2. int
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.
  1. static
  2. int
REASON_INHERITANCE_ADMINISTRATOR
States that operations can be executed on the associated object that require administrator rights.
  1. static
  2. int
REASON_INHERITANCE_EDITOR
States that operations can be executed on the associated object that require editor rights.
  1. static
  2. int
REASON_INHERITANCE_POTENTIAL_OWNER
States that operations can be executed on the associated object that require potential owner rights.
  1. static
  2. int
REASON_INHERITANCE_READER
States that operations can be executed on the associated object that require reader rights.
  1. static
  2. int
REASON_MAX
Do not use -internal only.
  1. static
  2. int
REASON_NONE
For the Post Processor Plugin.
  1. static
  2. int
REASON_OPENER
States that operations can be executed on the associated object that require opener rights.
  1. static
  2. int
REASON_ORIGINATOR
States that operations can be executed on the associated object that require originator rights.
  1. static
  2. int
REASON_OWNER
States that the associated object can be completed.
  1. static
  2. int
REASON_POTENTIAL_INSTANCE_CREATOR
States that operations can be executed on the associated object that require instance creator rights, for example, creating objects.
  1. static
  2. int
REASON_POTENTIAL_OWNER
States that the associated object can be claimed.
  1. static
  2. int
REASON_POTENTIAL_SENDER
Deprecated. Not used.
  1. static
  2. int
REASON_POTENTIAL_STARTER
States that operations can be executed on the associated object that require potential starter rights, for example, creating objects.
  1. static
  2. int
REASON_READER
States that operations can be executed on the associated object that require reader authority, for example, reading the properties of an object.
  1. static
  2. int
REASON_STARTER
States that operations can be executed on the associated object that require starter authority.
  1. static
  2. int
REASON_STATE_MACHINE_END
Do not use -internal only.
  1. static
  2. int
REASON_STATE_MACHINE_EVENT_AVAILABLE
Do not use -internal only.
  1. static
  2. int
REASON_STATE_MACHINE_START
Do not use -internal only.
  1. static
  2. int
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
  1. int
getAssignmentReason()
Returns the reason why the work item is assigned.
  1. int
getAssociatedObjectType()
Deprecated. As of version 7.0,0.3, obsolete for shared work items.
  1. OID
getAssociatedOid()
Deprecated. As of version 7.0,0.3, obsolete for shared work items.
  1. java.util.Calendar
getCreationTime()
Deprecated. As of version 7.0,0.3, obsolete for shared work items.
  1. java.lang.String
getGroupName()
Returns the name of the group of persons associated with the work item.
  1. com.ibm.bpe.api.WIID
getID()
Deprecated. As of version 7.0,0.3, obsolete for shared work items.
  1. boolean
getIsAssignedToEverybody()
Returns whether the workitem is assigned to everybody.
  1. OID
getObjectID()
Deprecated. As of version 7.0,0.3, obsolete for shared work items.
  1. int
getObjectType()
Deprecated. As of version 7.0,0.3, obsolete for shared work items.
  1. java.lang.String
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

  1. static final java.lang.String COPYRIGHT
See Also:

OBJECT_TYPE_STATE_MACHINE_INSTANCE

  1. static final int OBJECT_TYPE_STATE_MACHINE_INSTANCE
Do not use - internal only.
See Also:

OBJECT_TYPE_STATE_MACHINE_TEMPLATE

  1. static final int OBJECT_TYPE_STATE_MACHINE_TEMPLATE
Do not use - internal only.
See Also:

OBJECT_TYPE_APPLICATION_COMPONENT

  1. static final int OBJECT_TYPE_APPLICATION_COMPONENT
Do not use - internal only.
See Also:

OBJECT_TYPE_PROCESS_INSTANCE

  1. static final int OBJECT_TYPE_PROCESS_INSTANCE
States that the work item has been created for a process instance.
See Also:

OBJECT_TYPE_TASK_INSTANCE

  1. static final int OBJECT_TYPE_TASK_INSTANCE
States that the work item has been created for a task instance.
See Also:

OBJECT_TYPE_STATE_MACHINE_EVENT

  1. static final int OBJECT_TYPE_STATE_MACHINE_EVENT
Do not use - internal only.
See Also:

OBJECT_TYPE_PROCESS_TEMPLATE

  1. static final int OBJECT_TYPE_PROCESS_TEMPLATE
Do not use - internal only.
See Also:

OBJECT_TYPE_TASK_TEMPLATE

  1. static final int OBJECT_TYPE_TASK_TEMPLATE
Do not use - internal only.
See Also:

OBJECT_TYPE_WORK_BASKET

  1. static final int OBJECT_TYPE_WORK_BASKET
States that the work item has been created for a work basket.
See Also:

OBJECT_TYPE_ACTIVITY

  1. static final int OBJECT_TYPE_ACTIVITY
States that the work item has been created for an activity instance.
See Also:

OBJECT_TYPE_EVENT

  1. static final int OBJECT_TYPE_EVENT
States that the work item has been created for a receive event.
See Also:

OBJECT_TYPE_BUSINESS_CATEGORY

  1. static final int OBJECT_TYPE_BUSINESS_CATEGORY
States that the work item has been created for a business category.
See Also:

OBJECT_TYPE_ESCALATION_INSTANCE

  1. static final int OBJECT_TYPE_ESCALATION_INSTANCE
States that the work item has been created for an escalation instance.
See Also:

OBJECT_TYPE_MAX

  1. static final int OBJECT_TYPE_MAX
Do not use - internal only.
See Also:

OBJECT_TYPE_ESCALATION_TEMPLATE

  1. static final int OBJECT_TYPE_ESCALATION_TEMPLATE
Do not use - internal only.
See Also:

REASON_CUSTOMROLE_14

  1. static final int REASON_CUSTOMROLE_14
States that operations can be executed on the associated object that require rights defined by custom role 14.
See Also:

REASON_CUSTOMROLE_15

  1. static final int REASON_CUSTOMROLE_15
States that operations can be executed on the associated object that require rights defined by custom role 15.
See Also:

REASON_CUSTOMROLE_16

  1. static final int REASON_CUSTOMROLE_16
States that operations can be executed on the associated object that require rights defined by custom role 16.
See Also:

REASON_INHERITANCE_POTENTIAL_OWNER

  1. static final int REASON_INHERITANCE_POTENTIAL_OWNER
States that operations can be executed on the associated object that require potential owner rights. The right is inherited from an enclosing object.
See Also:

REASON_STATE_MACHINE_EVENT_AVAILABLE

  1. static final int REASON_STATE_MACHINE_EVENT_AVAILABLE
Do not use -internal only. (deprecated) As of version 7.5, no replacement.
See Also:

REASON_CUSTOMROLE_17

  1. static final int REASON_CUSTOMROLE_17
States that operations can be executed on the associated object that require rights defined by custom role 17.
See Also:

REASON_CUSTOMROLE_18

  1. static final int REASON_CUSTOMROLE_18
States that operations can be executed on the associated object that require rights defined by custom role 18.
See Also:

REASON_CUSTOMROLE_19

  1. static final int REASON_CUSTOMROLE_19
States that operations can be executed on the associated object that require rights defined by custom role 19.
See Also:

REASON_EDITOR

  1. 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 object.
See Also:

REASON_MAX

  1. static final int REASON_MAX
Do not use -internal only. (deprecated) As of version 7.5, no replacement.
See Also:

REASON_DISTRIBUTOR

  1. static final int REASON_DISTRIBUTOR
States that operations can be executed on the associated object that require distributor rights, for example, distributing objects to a work basket.
See Also:

REASON_OPENER

  1. static final int REASON_OPENER
States that operations can be executed on the associated object that require opener rights.
See Also:

REASON_INHERITANCE_READER

  1. static final int REASON_INHERITANCE_READER
States that operations can be executed on the associated object that require reader rights. The right is inherited from an enclosing object.
See Also:

REASON_TRANSFER_INITIATOR

  1. static final int 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.
See Also:

REASON_ORIGINATOR

  1. static final int REASON_ORIGINATOR
States that operations can be executed on the associated object that require originator rights.
See Also:

REASON_POTENTIAL_OWNER

  1. static final int REASON_POTENTIAL_OWNER
States that the associated object can be claimed.
See Also:

REASON_OWNER

  1. static final int REASON_OWNER
States that the associated object can be completed.
See Also:

REASON_STATE_MACHINE_END

  1. static final int REASON_STATE_MACHINE_END
Do not use -internal only. (deprecated) As of version 7.5, no replacement.
See Also:

REASON_CUSTOMROLE_20

  1. static final int REASON_CUSTOMROLE_20
States that operations can be executed on the associated object that require rights defined by custom role 20.
See Also:

REASON_INHERITANCE_ADMINISTRATOR

  1. static final int REASON_INHERITANCE_ADMINISTRATOR
States that operations can be executed on the associated object that require administrator rights. The right is inherited from an enclosing object.
See Also:

REASON_POTENTIAL_INSTANCE_CREATOR

  1. static final int REASON_POTENTIAL_INSTANCE_CREATOR
States that operations can be executed on the associated object that require instance creator rights, for example, creating objects.
See Also:

REASON_ESCALATION_RECEIVER

  1. 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 an object that is escalated.
See Also:

REASON_READER

  1. 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 object.
See Also:

REASON_STATE_MACHINE_START

  1. static final int REASON_STATE_MACHINE_START
Do not use -internal only. (deprecated) As of version 7.5, no replacement.
See Also:

REASON_APPENDER

  1. static final int REASON_APPENDER
States that operations can be executed on the associated object that require appender rights.
See Also:

REASON_POTENTIAL_SENDER

  1. static final int REASON_POTENTIAL_SENDER
Deprecated. Not used.
See Also:

REASON_ADMINISTRATOR

  1. static final int REASON_ADMINISTRATOR
States that operations can be executed on the associated object that require administrator rights, for example, deletion of an object.
See Also:

REASON_POTENTIAL_STARTER

  1. static final int REASON_POTENTIAL_STARTER
States that operations can be executed on the associated object that require potential starter rights, for example, creating objects.
See Also:

REASON_STARTER

  1. static final int REASON_STARTER
States that operations can be executed on the associated object that require starter authority.
See Also:

REASON_CUSTOMROLE_1

  1. static final int REASON_CUSTOMROLE_1
States that operations can be executed on the associated object that require rights defined by custom role 1.
See Also:

REASON_CUSTOMROLE_2

  1. static final int REASON_CUSTOMROLE_2
States that operations can be executed on the associated object that require rights defined by custom role 2.
See Also:

REASON_CUSTOMROLE_3

  1. static final int REASON_CUSTOMROLE_3
States that operations can be executed on the associated object that require rights defined by custom role 3.
See Also:

REASON_CUSTOMROLE_4

  1. static final int REASON_CUSTOMROLE_4
States that operations can be executed on the associated object that require rights defined by custom role 4.
See Also:

REASON_CUSTOMROLE_5

  1. static final int REASON_CUSTOMROLE_5
States that operations can be executed on the associated object that require rights defined by custom role 5.
See Also:

REASON_CUSTOMROLE_6

  1. static final int REASON_CUSTOMROLE_6
States that operations can be executed on the associated object that require rights defined by custom role 6.
See Also:

REASON_CUSTOMROLE_7

  1. static final int REASON_CUSTOMROLE_7
States that operations can be executed on the associated object that require rights defined by custom role 7.
See Also:

REASON_CUSTOMROLE_8

  1. static final int REASON_CUSTOMROLE_8
States that operations can be executed on the associated object that require rights defined by custom role 8.
See Also:

REASON_CUSTOMROLE_10

  1. static final int REASON_CUSTOMROLE_10
States that operations can be executed on the associated object that require rights defined by custom role 10.
See Also:

REASON_CUSTOMROLE_9

  1. static final int REASON_CUSTOMROLE_9
States that operations can be executed on the associated object that require rights defined by custom role 9.
See Also:

REASON_CUSTOMROLE_11

  1. static final int REASON_CUSTOMROLE_11
States that operations can be executed on the associated object that require rights defined by custom role 11.
See Also:

REASON_INHERITANCE_EDITOR

  1. static final int REASON_INHERITANCE_EDITOR
States that operations can be executed on the associated object that require editor rights. The right is inherited from an enclosing object.
See Also:

REASON_CUSTOMROLE_12

  1. static final int REASON_CUSTOMROLE_12
States that operations can be executed on the associated object that require rights defined by custom role 12.
See Also:

REASON_CUSTOMROLE_13

  1. static final int REASON_CUSTOMROLE_13
States that operations can be executed on the associated object that require rights defined by custom role 13.
See Also:

REASON_NONE

  1. static final int REASON_NONE
For the Post Processor Plugin.
See Also:

Method Detail

getID

  1. com.ibm.bpe.api.WIID getID()
Deprecated. As of version 7.0,0.3, obsolete for shared work items.
Returns the object identifier.

getOwnerID

  1. java.lang.String getOwnerID()
Returns the user ID of the workitem owner if the work item is not assigned to everybody or to a group of persons.

getIsAssignedToEverybody

  1. boolean getIsAssignedToEverybody( )
Returns whether the workitem is assigned to everybody. If assigned to everybody, the owner ID and the group name are null strings.

getObjectType

  1. int getObjectType()
Deprecated. As of version 7.0,0.3, obsolete for shared work items.
Returns the type of the associated object.

getObjectID

  1. OID getObjectID()
Deprecated. As of version 7.0,0.3, obsolete for shared work items.
Returns the object ID of the associated object.

getAssociatedObjectType

  1. int getAssociatedObjectType()
Deprecated. As of version 7.0,0.3, obsolete for shared work items.
Returns the type of the object associated to or containing the work item's associated object.

getAssociatedOid

  1. OID getAssociatedOid()
Deprecated. As of version 7.0,0.3, obsolete for shared work items.
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

  1. int getAssignmentReason()
Returns the reason why the work item is assigned.

getCreationTime

  1. java.util.Calendar getCreationTime( )
Deprecated. As of version 7.0,0.3, obsolete for shared work items.
Returns the creation time of the work item.

getGroupName

  1. java.lang.String getGroupName()
Returns the name of the group of persons associated with the work item. If there is no group associated, null is returned.