public interface ProcessInstanceStep
ProcessInstanceHistory
Modifier and Type | Interface and Description |
---|---|
static class |
ProcessInstanceStep.WaitTaskState
Represents the different states of a wait task.
|
Modifier and Type | Method and Description |
---|---|
Boolean |
getConditionResult()
Returns the result of the condition.
|
DataContext |
getDataContextAfter()
Returns the state of the data context just after the execution of the step.
|
DataContext |
getDataContextBefore()
Returns the state of the data context just before the execution of the step.
|
UserMessage |
getDescription()
Returns the description of this step.
|
Date |
getEndDate()
Returns the end date of this step.
|
int |
getId()
Returns the identifier of this step.
|
UserMessage |
getLabel()
Returns the label of this step.
|
Date |
getStartDate()
Returns the start date of this step.
|
List<ProcessInstance> |
getSubWorkflowsInvocationSubWorkflows()
Deprecated.
Since 5.7.0. This method is replaced by
getSubWorkflowsKeys() |
List<ProcessInstanceKey> |
getSubWorkflowsKeys()
Returns the list including the key of each sub-workflow created by this step or
null if this step
is not a sub-workflow invocation. |
UserTask.CompletionStrategy |
getUserTaskCompletionStrategy()
Returns the end criteria of the user task.
|
UserTask.UserTaskMode |
getUserTaskMode()
Returns the user task mode or
null if this step is not a user task. |
UserTask.WorkItem |
getUserTaskWorkItem()
Returns the work item associated to the user task or
null if this step is not a user task. |
List<UserTask.WorkItem> |
getUserTaskWorkItems()
Returns the list of work items associated with the user task.
|
Profile |
getWaitTaskExpectedProfile()
Returns the profile authorized to resume the wait task;
returns
null if this step is not a wait task. |
Boolean |
getWaitTaskHasBeenForcedToResume()
Returns
Boolean.TRUE if the resumption has been done by an administration action;
returns null if this step is not a wait task. |
Map<String,String> |
getWaitTaskReceivedParameters()
Returns the parameters which were received when the wait task was resumed;
returns
null if this step is not a wait task. |
String |
getWaitTaskResumeId()
Returns the resumption identifier associated with the wait task;
returns
null if this step is not a wait task. |
ProcessInstanceStep.WaitTaskState |
getWaitTaskState()
Returns the current state of the wait task;
returns
null if this step is not a wait task. |
boolean |
isCondition()
Returns
true if this step is a condition. |
boolean |
isCurrentStep()
Returns
true if this step is the current step of the process instance. |
boolean |
isHiddenInProgressView()
Indicates if the step has been defined as hidden in the progress view.
|
boolean |
isScriptTask()
Returns
true if this step is a script task. |
boolean |
isSubWorkflowsInvocation()
Returns
true if this step is a sub-workflow invocation. |
boolean |
isUserTask()
Returns
true if this step is a user task. |
boolean |
isWaitTask()
Returns
true if this step is a wait task. |
int getId()
Date getStartDate()
Date getEndDate()
UserMessage getLabel()
UserMessage getDescription()
DataContext getDataContextBefore()
DataContext getDataContextAfter()
boolean isScriptTask()
true
if this step is a script task.boolean isUserTask()
true
if this step is a user task.boolean isCondition()
true
if this step is a condition.boolean isSubWorkflowsInvocation()
true
if this step is a sub-workflow invocation.boolean isWaitTask()
true
if this step is a wait task.boolean isCurrentStep()
true
if this step is the current step of the process instance.Boolean getConditionResult()
Returns null
if this step is not a condition.
isCondition()
List<UserTask.WorkItem> getUserTaskWorkItems()
null
if this step is not a user task.
In the default user task mode (single work item), this method returns a list
with a single work item.
For the default single work item mode,
it is recommended to use instead getUserTaskWorkItem()
.
List
of UserTask.WorkItem
.isUserTask()
UserTask.WorkItem getUserTaskWorkItem()
null
if this step is not a user task.
In the legacy user task mode, this method throws an exception if user tasks have several work items.
IllegalStateException
- if user tasks have several work items.UserTask.UserTaskMode getUserTaskMode()
null
if this step is not a user task.
This method is useful to know which method
must be called (getUserTaskWorkItem()
or getUserTaskWorkItems()
).
UserTask.CompletionStrategy getUserTaskCompletionStrategy()
Returns null
if the step is not a user task.
In the default user task mode (single work item), this method always returns the criteria
UserTask.CompletionStrategy.ALL_WORK_ITEMS_COMPLETED
.
isUserTask()
List<ProcessInstance> getSubWorkflowsInvocationSubWorkflows()
getSubWorkflowsKeys()
null
if this step is not a sub-workflow
invocation.
This method will return an empty list if the sub-workflows were deleted.
To get the history of a sub-workflow, use WorkflowEngine.getProcessInstanceHistory(ProcessInstanceKey)
with the key of the sub-workflow.
List
of ProcessInstance
.List<ProcessInstanceKey> getSubWorkflowsKeys()
null
if this step
is not a sub-workflow invocation.
To get the history of a sub workflow, use WorkflowEngine.getProcessInstanceHistory(ProcessInstanceKey)
with the key of the sub-workflow.
List
of ProcessInstanceKey
.Map<String,String> getWaitTaskReceivedParameters()
null
if this step is not a wait task.Map
of parameters (key: parameter name, value: parameter value).String getWaitTaskResumeId()
null
if this step is not a wait task.
This identifier is required to resume a wait task.
Profile getWaitTaskExpectedProfile()
null
if this step is not a wait task.Boolean getWaitTaskHasBeenForcedToResume()
Boolean.TRUE
if the resumption has been done by an administration action;
returns null
if this step is not a wait task.ProcessInstanceStep.WaitTaskState getWaitTaskState()
null
if this step is not a wait task.boolean isHiddenInProgressView()