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