Package org.camunda.bpm.engine.history
Interface HistoricCaseInstance
- All Known Implementing Classes:
HistoricCaseInstanceEntity
public interface HistoricCaseInstance
A single execution of a case definition that is stored permanently.
- Author:
- Sebastian Menski
-
Method Summary
Modifier and TypeMethodDescriptionThe user provided unique reference to this process instance.The case definition reference.The case definition keyThe case definition nameThe time the case was closed.The time the case was created.The authenticated user that created this case instance.The difference betweengetCloseTime()
andgetCreateTime()
.getId()
The case instance id (== as the id of the runtimeCaseInstance
).The case instance id of a potential super case instance or null if no super case instance exists.The process instance id of a potential super process instance or null if no super process instance exists.The id of the tenant this historic case instance belongs to.boolean
isActive()
Check if the case is active.boolean
isClosed()
Check if the case is closed.boolean
Check if the case is completed.boolean
Check if the case is terminated.
-
Method Details
-
getId
String getId()The case instance id (== as the id of the runtimeCaseInstance
). -
getBusinessKey
String getBusinessKey()The user provided unique reference to this process instance. -
getCaseDefinitionId
String getCaseDefinitionId()The case definition reference. -
getCaseDefinitionKey
String getCaseDefinitionKey()The case definition key -
getCaseDefinitionName
String getCaseDefinitionName()The case definition name -
getCreateTime
Date getCreateTime()The time the case was created. -
getCloseTime
Date getCloseTime()The time the case was closed. -
getDurationInMillis
Long getDurationInMillis()The difference betweengetCloseTime()
andgetCreateTime()
. -
getCreateUserId
String getCreateUserId()The authenticated user that created this case instance. -
getSuperCaseInstanceId
String getSuperCaseInstanceId()The case instance id of a potential super case instance or null if no super case instance exists. -
getSuperProcessInstanceId
String getSuperProcessInstanceId()The process instance id of a potential super process instance or null if no super process instance exists. -
getTenantId
String getTenantId()The id of the tenant this historic case instance belongs to. Can benull
if the historic case instance belongs to no single tenant. -
isActive
boolean isActive()Check if the case is active. -
isCompleted
boolean isCompleted()Check if the case is completed. -
isTerminated
boolean isTerminated()Check if the case is terminated. -
isClosed
boolean isClosed()Check if the case is closed.
-