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 java.lang.String
getBusinessKey()
The user provided unique reference to this process instance.java.lang.String
getCaseDefinitionId()
The case definition reference.java.lang.String
getCaseDefinitionKey()
The case definition keyjava.lang.String
getCaseDefinitionName()
The case definition namejava.util.Date
getCloseTime()
The time the case was closed.java.util.Date
getCreateTime()
The time the case was created.java.lang.String
getCreateUserId()
The authenticated user that created this case instance.java.lang.Long
getDurationInMillis()
The difference betweengetCloseTime()
andgetCreateTime()
.java.lang.String
getId()
The case instance id (== as the id of the runtimeCaseInstance
).java.lang.String
getSuperCaseInstanceId()
The case instance id of a potential super case instance or null if no super case instance exists.java.lang.String
getSuperProcessInstanceId()
The process instance id of a potential super process instance or null if no super process instance exists.java.lang.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
java.lang.String getId()
The case instance id (== as the id of the runtimeCaseInstance
).
-
getBusinessKey
java.lang.String getBusinessKey()
The user provided unique reference to this process instance.
-
getCaseDefinitionId
java.lang.String getCaseDefinitionId()
The case definition reference.
-
getCaseDefinitionKey
java.lang.String getCaseDefinitionKey()
The case definition key
-
getCaseDefinitionName
java.lang.String getCaseDefinitionName()
The case definition name
-
getCreateTime
java.util.Date getCreateTime()
The time the case was created.
-
getCloseTime
java.util.Date getCloseTime()
The time the case was closed.
-
getDurationInMillis
java.lang.Long getDurationInMillis()
The difference betweengetCloseTime()
andgetCreateTime()
.
-
getCreateUserId
java.lang.String getCreateUserId()
The authenticated user that created this case instance.
-
getSuperCaseInstanceId
java.lang.String getSuperCaseInstanceId()
The case instance id of a potential super case instance or null if no super case instance exists.
-
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 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.
-
-