public interface ProcessInstance
Modifier and Type | Method and Description |
---|---|
Date |
getCreationDate()
Returns the creation date of this workflow.
|
UserReference |
getCreator()
Returns the user that created this workflow.
|
List<ProcessInstance> |
getCurrentSubWorkflows()
Returns the list of the current sub-workflows; if no current sub-workflows
exist, returns an empty list.
|
DataContextReadOnly |
getDataContext()
Returns the data context of this workflow.
|
UserMessage |
getDescription()
Returns the description of this workflow.
|
UserMessage |
getLabel()
Returns the label of this workflow.
|
Date |
getLastModificationDate()
Returns the last modified date of this workflow.
|
ProcessInstanceKey |
getParentKey()
Returns the parent of the sub-workflow if the process instance is a sub-workflow,
otherwise returns
null . |
Integer |
getPriority()
Returns the current priority of this workflow if defined,
otherwise returns
null . |
Integer |
getPriorityOrDefaultPriority()
Returns the current priority of this workflow
or the default priority if defined, else
null . |
ProcessInstanceKey |
getProcessInstanceKey()
Returns the identifier of this workflow.
|
PublishedProcessKey |
getPublishProcessKey()
Returns the identifier of the associated workflow publication.
|
String |
getSubWorkflowName()
Returns the identifier of a sub-workflow in the case of
a dynamic sub-workflow invocation.
|
List<ProcessInstance> |
getSubWorkflows()
Returns the list of all the sub-workflows (past or current) of this workflow; if no sub-workflows
exist, returns an empty list.
|
List<UserTask.WorkItem> |
getWorkItems()
Returns the list of the current work items if this workflow is
currently executing a user task.
|
boolean |
isCompleted()
Returns
true if this workflow is completed,
returns false otherwise. |
boolean |
isInError()
Returns
true if this workflow has errors,
otherwise returns false . |
boolean |
isSubWorkflow()
Returns
true if the process instance is a sub-workflow,
otherwise returns false . |
ProcessInstanceKey getProcessInstanceKey()
PublishedProcessKey getPublishProcessKey()
In the case of a sub-workflow, this method returns the key of the publication associated with the main workflow.
UserMessage getLabel()
UserMessage getDescription()
UserReference getCreator()
Date getCreationDate()
Date getLastModificationDate()
Integer getPriority()
null
.Integer getPriorityOrDefaultPriority()
null
.boolean isCompleted()
true
if this workflow is completed,
returns false
otherwise.boolean isInError()
true
if this workflow has errors,
otherwise returns false
.List<UserTask.WorkItem> getWorkItems()
If this workflow is complete, or the current step is not a user task, this method returns an empty list.
List
of UserTask.WorkItem
.DataContextReadOnly getDataContext()
List<ProcessInstance> getSubWorkflows()
The returned sub-workflows may be active or completed (@link isCompleted()
.
List
of ProcessInstance
.List<ProcessInstance> getCurrentSubWorkflows()
The current sub-workflows are the sub-workflows for which the workflow is waiting; this is to say the sub-workflows matching with the current sub-workflows invocation step.
The returned sub-workflows may be active or completed (@link isCompleted()
.
List
of ProcessInstance
.String getSubWorkflowName()
ProcessInstanceKey getParentKey()
null
.isSubWorkflow()
boolean isSubWorkflow()
true
if the process instance is a sub-workflow,
otherwise returns false
.