Interface CaseExecution
-
- All Known Subinterfaces:
CaseInstance
- All Known Implementing Classes:
CaseExecutionEntity
public interface CaseExecution
Represent a planned item in a case instance.
Note that a
CaseInstance
also is an case execution.- Author:
- Roman Smirnov
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getActivityDescription()
The description of the activity associated withthis
case execution.String
getActivityId()
The id of the activity associated withthis
case execution.String
getActivityName()
The name of the activity associated withthis
case execution.String
getActivityType()
The type of the activity associated withthis
case execution.String
getCaseDefinitionId()
The id of the case definition of the case execution.String
getCaseInstanceId()
Id of the root of the case execution tree representing the case instance.String
getId()
The unique identifier of the case execution.String
getParentId()
The id of the parent ofthis
case execution.String
getTenantId()
The id of the tenant this case execution belongs to.boolean
isActive()
Returnstrue
if the case execution is active.boolean
isAvailable()
Returnstrue
if the case execution is available.boolean
isDisabled()
Returnstrue
if the case execution is disabled.boolean
isEnabled()
Returnstrue
if the case execution is enabled.boolean
isRequired()
Returnstrue
if the case execution is required.boolean
isTerminated()
Returnstrue
if 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
this
case execution.
-
getActivityName
String getActivityName()
The name of the activity associated with
this
case execution.
-
getActivityType
String getActivityType()
The type of the activity associated with
this
case execution.
-
getActivityDescription
String getActivityDescription()
The description of the activity associated with
this
case execution.
-
getParentId
String getParentId()
The id of the parent of
this
case execution.
-
isRequired
boolean isRequired()
Returns
true
if the case execution is required.
-
isAvailable
boolean isAvailable()
Returns
true
if the case execution is available.
-
isActive
boolean isActive()
Returns
true
if the case execution is active.
-
isEnabled
boolean isEnabled()
Returns
true
if the case execution is enabled.Note: If this case execution is the case execution, it will return always
false
.
-
isDisabled
boolean isDisabled()
Returns
true
if the case execution is disabled.Note: If this case execution is the case instance, it will return always
false
.
-
isTerminated
boolean isTerminated()
Returns
true
if the case execution is terminated.
-
getTenantId
String getTenantId()
The id of the tenant this case execution belongs to. Can benull
if the case execution belongs to no single tenant.
-
-