Package org.flowable.engine.runtime
Interface ProcessInstance
-
- All Superinterfaces:
Execution
public interface ProcessInstance extends Execution
Represents one execution of aProcessDefinition
.- Author:
- Tom Baeyens, Joram Barrez, Daniel Meyer, Tijs Rademakers
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getBusinessKey()
The business key of this process instance.String
getBusinessStatus()
The business status of this process instance.String
getCallbackId()
Returns the callback id of this process instance.String
getCallbackType()
Returns the callback type of this process instance.String
getDeploymentId()
The deployment id of the process definition of the process instance.String
getDescription()
Returns the description of this process instance.String
getLocalizedDescription()
Returns the localized description of this process instance.String
getLocalizedName()
Returns the localized name of this process instance.String
getName()
Returns the name of this process instance.String
getProcessDefinitionId()
The id of the process definition of the process instance.String
getProcessDefinitionKey()
The key of the process definition of the process instance.String
getProcessDefinitionName()
The name of the process definition of the process instance.Integer
getProcessDefinitionVersion()
The version of the process definition of the process instance.Map<String,Object>
getProcessVariables()
Returns the process variables if requested in the process instance queryDate
getStartTime()
Returns the start time of this process instance.String
getStartUserId()
Returns the user id of this process instance.String
getTenantId()
The tenant identifier of this process instanceboolean
isSuspended()
returns true if the process instance is suspended-
Methods inherited from interface org.flowable.engine.runtime.Execution
getActivityId, getId, getParentId, getProcessInstanceId, getPropagatedStageInstanceId, getReferenceId, getReferenceType, getRootProcessInstanceId, getSuperExecutionId, isEnded
-
-
-
-
Method Detail
-
getProcessDefinitionId
String getProcessDefinitionId()
The id of the process definition of the process instance.
-
getProcessDefinitionName
String getProcessDefinitionName()
The name of the process definition of the process instance.
-
getProcessDefinitionKey
String getProcessDefinitionKey()
The key of the process definition of the process instance.
-
getProcessDefinitionVersion
Integer getProcessDefinitionVersion()
The version of the process definition of the process instance.
-
getDeploymentId
String getDeploymentId()
The deployment id of the process definition of the process instance.
-
getBusinessKey
String getBusinessKey()
The business key of this process instance.
-
getBusinessStatus
String getBusinessStatus()
The business status of this process instance.
-
isSuspended
boolean isSuspended()
returns true if the process instance is suspended- Specified by:
isSuspended
in interfaceExecution
-
getProcessVariables
Map<String,Object> getProcessVariables()
Returns the process variables if requested in the process instance query
-
getTenantId
String getTenantId()
The tenant identifier of this process instance- Specified by:
getTenantId
in interfaceExecution
-
getName
String getName()
Returns the name of this process instance.
-
getDescription
String getDescription()
Returns the description of this process instance.- Specified by:
getDescription
in interfaceExecution
-
getLocalizedName
String getLocalizedName()
Returns the localized name of this process instance.
-
getLocalizedDescription
String getLocalizedDescription()
Returns the localized description of this process instance.
-
getStartTime
Date getStartTime()
Returns the start time of this process instance.
-
getStartUserId
String getStartUserId()
Returns the user id of this process instance.
-
getCallbackId
String getCallbackId()
Returns the callback id of this process instance.
-
getCallbackType
String getCallbackType()
Returns the callback type of this process instance.
-
-