Interface CaseExecution
-
- All Known Subinterfaces:
CaseInstance
- All Known Implementing Classes:
CaseExecutionEntity
public interface CaseExecutionRepresent a planned item in a case instance.
Note that a
CaseInstancealso is an case execution.- Author:
- Roman Smirnov
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetActivityDescription()The description of the activity associated withthiscase execution.StringgetActivityId()The id of the activity associated withthiscase execution.StringgetActivityName()The name of the activity associated withthiscase execution.StringgetActivityType()The type of the activity associated withthiscase execution.StringgetCaseDefinitionId()The id of the case definition of the case execution.StringgetCaseInstanceId()Id of the root of the case execution tree representing the case instance.StringgetId()The unique identifier of the case execution.StringgetParentId()The id of the parent ofthiscase execution.StringgetTenantId()The id of the tenant this case execution belongs to.booleanisActive()Returnstrueif the case execution is active.booleanisAvailable()Returnstrueif the case execution is available.booleanisDisabled()Returnstrueif the case execution is disabled.booleanisEnabled()Returnstrueif the case execution is enabled.booleanisRequired()Returnstrueif the case execution is required.booleanisTerminated()Returnstrueif the case execution is terminated.
-
-
-
Method Detail
-
getId
String getId()
The unique identifier of the case execution.
-
getCaseInstanceId
String getCaseInstanceId()
Id of the root of the case execution tree representing the case instance.
It is the same as
getId()if this case execution is the case instance.
-
getCaseDefinitionId
String getCaseDefinitionId()
The id of the case definition of the case execution.
-
getActivityId
String getActivityId()
The id of the activity associated with
thiscase execution.
-
getActivityName
String getActivityName()
The name of the activity associated with
thiscase execution.
-
getActivityType
String getActivityType()
The type of the activity associated with
thiscase execution.
-
getActivityDescription
String getActivityDescription()
The description of the activity associated with
thiscase execution.
-
getParentId
String getParentId()
The id of the parent of
thiscase execution.
-
isRequired
boolean isRequired()
Returns
trueif the case execution is required.
-
isAvailable
boolean isAvailable()
Returns
trueif the case execution is available.
-
isActive
boolean isActive()
Returns
trueif the case execution is active.
-
isEnabled
boolean isEnabled()
Returns
trueif the case execution is enabled.Note: If this case execution is the case execution, it will return always
false.
-
isDisabled
boolean isDisabled()
Returns
trueif the case execution is disabled.Note: If this case execution is the case instance, it will return always
false.
-
isTerminated
boolean isTerminated()
Returns
trueif the case execution is terminated.
-
getTenantId
String getTenantId()
The id of the tenant this case execution belongs to. Can benullif the case execution belongs to no single tenant.
-
-