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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getBusinessKey()
The user provided unique reference to this process instance.String
getCaseDefinitionId()
The case definition reference.String
getCaseDefinitionKey()
The case definition keyString
getCaseDefinitionName()
The case definition nameDate
getCloseTime()
The time the case was closed.Date
getCreateTime()
The time the case was created.String
getCreateUserId()
The authenticated user that created this case instance.Long
getDurationInMillis()
The difference betweengetCloseTime()
andgetCreateTime()
.String
getId()
The case instance id (== as the id of the runtimeCaseInstance
).String
getSuperCaseInstanceId()
The case instance id of a potential super case instance or null if no super case instance exists.String
getSuperProcessInstanceId()
The process instance id of a potential super process instance or null if no super process instance exists.String
getTenantId()
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
isCompleted()
Check if the case is completed.boolean
isTerminated()
Check if the case is terminated.
-
-
-
Method Detail
-
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.
-
-