Package org.camunda.bpm.engine.history
Interface HistoricProcessInstance
- All Known Implementing Classes:
HistoricProcessInstanceEntity
public interface HistoricProcessInstance
A single execution of a whole process definition that is stored permanently.
- Author:
- Christian Stettler, Askar Akhmerov
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionThe user provided unique reference to this process instance.The case instance id of a potential super case instance or null if no super case instance existsObtains the reason for the process instance's deletion.The difference betweengetEndTime()
andgetStartTime()
.Deprecated.The time the process was ended.getId()
The process instance id (== as the id for the runtimeprocess instance
).The process definition reference.The process definition key reference.The process definition name.The process definition version.The time the historic process instance will be removed.The id of the original process instance which was restarted.The process instance id of the top-level (root) process instance or null if no root process instance existsThe start activity.The time the process was started.The authenticated user that started this process instance.getState()
Return current state of HistoricProcessInstance, following values are recognized during process engine operations: STATE_ACTIVE - running process instance STATE_SUSPENDED - suspended process instances STATE_COMPLETED - completed through normal end event STATE_EXTERNALLY_TERMINATED - terminated externally, for instance through REST API STATE_INTERNALLY_TERMINATED - terminated internally, for instance by terminating boundary eventThe case instance id of a potential super case instance or null if no super case instance existsThe process instance id of a potential super process instance or null if no super process instance existsThe id of the tenant this historic process instance belongs to.
-
Field Details
-
STATE_ACTIVE
- See Also:
-
STATE_SUSPENDED
- See Also:
-
STATE_COMPLETED
- See Also:
-
STATE_EXTERNALLY_TERMINATED
- See Also:
-
STATE_INTERNALLY_TERMINATED
- See Also:
-
-
Method Details
-
getId
String getId()The process instance id (== as the id for the runtimeprocess instance
). -
getBusinessKey
String getBusinessKey()The user provided unique reference to this process instance. -
getProcessDefinitionKey
String getProcessDefinitionKey()The process definition key reference. -
getProcessDefinitionId
String getProcessDefinitionId()The process definition reference. -
getProcessDefinitionName
String getProcessDefinitionName()The process definition name. -
getProcessDefinitionVersion
Integer getProcessDefinitionVersion()The process definition version. -
getStartTime
Date getStartTime()The time the process was started. -
getEndTime
Date getEndTime()The time the process was ended. -
getRemovalTime
Date getRemovalTime()The time the historic process instance will be removed. -
getDurationInMillis
Long getDurationInMillis()The difference betweengetEndTime()
andgetStartTime()
. -
getEndActivityId
Deprecated.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 aHistoricActivityInstanceQuery
instead to query for end events of the process instance (use the activityTYpe attribute) -
getStartUserId
String getStartUserId()The authenticated user that started this process instance. -
getStartActivityId
String getStartActivityId()The start activity. -
getDeleteReason
String getDeleteReason()Obtains the reason for the process instance's deletion. -
getSuperProcessInstanceId
String getSuperProcessInstanceId()The process instance id of a potential super process instance or null if no super process instance exists -
getRootProcessInstanceId
String getRootProcessInstanceId()The process instance id of the top-level (root) process instance or null if no root process instance exists -
getSuperCaseInstanceId
String getSuperCaseInstanceId()The case instance id of a potential super case instance or null if no super case instance exists -
getCaseInstanceId
String getCaseInstanceId()The case instance id of a potential super case instance or null if no super case instance exists -
getTenantId
String getTenantId()The id of the tenant this historic process instance belongs to. Can benull
if the historic process instance belongs to no single tenant. -
getState
String getState()Return current state of HistoricProcessInstance, following values are recognized during process engine operations: STATE_ACTIVE - running process instance STATE_SUSPENDED - suspended process instances STATE_COMPLETED - completed through normal end event STATE_EXTERNALLY_TERMINATED - terminated externally, for instance through REST API STATE_INTERNALLY_TERMINATED - terminated internally, for instance by terminating boundary event -
getRestartedProcessInstanceId
String getRestartedProcessInstanceId()The id of the original process instance which was restarted.
-