public static interface UserTask.WorkItem
Modifier and Type | Interface and Description |
---|---|
static class |
UserTask.WorkItem.State |
Modifier and Type | Method and Description |
---|---|
String |
getComment()
Returns the work item comment.
|
Date |
getCompletionDate()
Returns the completion date of the work item.
|
UserMessage |
getDescription()
Returns description of the associated node.
|
int |
getItemIndex()
Returns the work item index.
|
UserMessage |
getLabel()
Returns label of the associated node.
|
Role |
getOfferedTo()
Deprecated.
Since 5.7.0. This method is replaced by
getOfferedToProfiles() . |
List<Profile> |
getOfferedToProfiles()
Returns the list of profiles the work item is offered to.
|
ProcessInstanceKey |
getProcessInstanceKey()
Returns the
ProcessInstanceKey of the workflow associated to the current work item. |
UserMessage |
getSpecificLabel()
Returns the specific label of the work item.
|
Date |
getStartDate()
Returns the start date of the work item.
|
UserTask.WorkItem.State |
getState()
Returns the current state of the work item.
|
UserReference |
getUserReference()
Returns the owner of the work item.
|
WorkItemKey |
getWorkItemKey()
Returns the identifier of the work item.
|
boolean |
hasReachedDeadline()
Returns
true if the deadline has been reached
for the current work item. |
boolean |
isAccepted()
Returns
true if the work item is accepted. |
boolean |
isRejected()
Returns
true if the work item is rejected. |
boolean |
isRejectEnabled()
Returns
true if the rejection is enabled for the work item
(the activation of the rejection is specified in the user task definition). |
ProcessInstanceKey getProcessInstanceKey()
ProcessInstanceKey
of the workflow associated to the current work item.boolean isAccepted()
true
if the work item is accepted.
Returns false
if no interaction has been found for the work item.
boolean isRejected()
true
if the work item is rejected.
Returns false
if no interaction has been found for the work item.
boolean isRejectEnabled()
true
if the rejection is enabled for the work item
(the activation of the rejection is specified in the user task definition).boolean hasReachedDeadline()
true
if the deadline has been reached
for the current work item.
Returns false
if the work item is completed or past.
String getComment()
UserReference getUserReference()
Role getOfferedTo()
getOfferedToProfiles()
.IllegalStateException
- if the work item is offered to more than one profile or if the profile is not a
role.List<Profile> getOfferedToProfiles()
UserMessage getLabel()
UserMessage getDescription()
int getItemIndex()
UserMessage getSpecificLabel()
UserTask.WorkItem.State getState()
Date getStartDate()
This is the date on which the work item entered the started state.
Date getCompletionDate()
This is the date on which the work item entered the completed state.
Returns null
if the work item has not been completed.
getState()
WorkItemKey getWorkItemKey()
This method may return null
in some cases,
for example, if the work item has been deleted and does not
have primary key.