Package org.activiti.engine.history
Interface HistoricProcessInstance
-
- All Known Subinterfaces:
HistoricProcessInstanceEntity
- All Known Implementing Classes:
HistoricProcessInstanceEntityImpl
@Internal public interface HistoricProcessInstance
A single execution of a whole process definition that is stored permanently.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.StringgetBusinessKey()The user provided unique reference to this process instance.java.lang.StringgetDeleteReason()Obtains the reason for the process instance's deletion.java.lang.StringgetDeploymentId()The deployment id of the process definition of the process instance.java.lang.StringgetDescription()The description for the process instance.java.lang.LonggetDurationInMillis()The difference betweengetEndTime()andgetStartTime().java.lang.StringgetEndActivityId()Reference to the activity in which this process instance ended.java.util.DategetEndTime()The time the process was ended.java.lang.StringgetId()The process instance id (== as the id for the runtimeprocess instance).java.lang.StringgetName()The name for the process instance.java.lang.StringgetProcessDefinitionId()The process definition reference.java.lang.StringgetProcessDefinitionKey()The key of the process definition of the process instance.java.lang.StringgetProcessDefinitionName()The name of the process definition of the process instance.java.lang.IntegergetProcessDefinitionVersion()The version of the process definition of the process instance.java.util.Map<java.lang.String,java.lang.Object>getProcessVariables()Returns the process variables if requested in the process instance queryjava.lang.StringgetStartActivityId()The start activity.java.util.DategetStartTime()The time the process was started.java.lang.StringgetStartUserId()The authenticated user that started this process instance.java.lang.StringgetSuperProcessInstanceId()The process instance id of a potential super process instance or null if no super process instance existsjava.lang.StringgetTenantId()The tenant identifier for the process instance.
-
-
-
Method Detail
-
getId
java.lang.String getId()
The process instance id (== as the id for the runtimeprocess instance).
-
getBusinessKey
java.lang.String getBusinessKey()
The user provided unique reference to this process instance.
-
getProcessDefinitionId
java.lang.String getProcessDefinitionId()
The process definition reference.
-
getProcessDefinitionName
java.lang.String getProcessDefinitionName()
The name of the process definition of the process instance.
-
getProcessDefinitionKey
java.lang.String getProcessDefinitionKey()
The key of the process definition of the process instance.
-
getProcessDefinitionVersion
java.lang.Integer getProcessDefinitionVersion()
The version of the process definition of the process instance.
-
getDeploymentId
java.lang.String getDeploymentId()
The deployment id of the process definition of the process instance.
-
getStartTime
java.util.Date getStartTime()
The time the process was started.
-
getEndTime
java.util.Date getEndTime()
The time the process was ended.
-
getDurationInMillis
java.lang.Long getDurationInMillis()
The difference betweengetEndTime()andgetStartTime().
-
getEndActivityId
java.lang.String getEndActivityId()
Reference to the activity in which this process instance ended. Note that a process instance can have multiple end events, in this case it might not be deterministic which activity id will be referenced here. Use aHistoricActivityInstanceQueryinstead to query for end events of the process instance (use the activityTYpe attribute)
-
getStartUserId
java.lang.String getStartUserId()
The authenticated user that started this process instance.- See Also:
IdentityService#setAuthenticatedUserId(String)
-
getStartActivityId
java.lang.String getStartActivityId()
The start activity.
-
getDeleteReason
java.lang.String getDeleteReason()
Obtains the reason for the process instance's deletion.
-
getSuperProcessInstanceId
java.lang.String getSuperProcessInstanceId()
The process instance id of a potential super process instance or null if no super process instance exists
-
getTenantId
java.lang.String getTenantId()
The tenant identifier for the process instance.
-
getName
java.lang.String getName()
The name for the process instance.
-
getDescription
java.lang.String getDescription()
The description for the process instance.
-
getProcessVariables
java.util.Map<java.lang.String,java.lang.Object> getProcessVariables()
Returns the process variables if requested in the process instance query
-
-