CaseExecution (camunda BPM Javadocs 7.8.0-SNAPSHOT)

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

Methods
Modifier and Type	Method and Description
`String`	`getActivityDescription()` The description of the activity associated with `this` case execution.
`String`	`getActivityId()` The id of the activity associated with `this` case execution.
`String`	`getActivityName()` The name of the activity associated with `this` case execution.
`String`	`getActivityType()` The type of the activity associated with `this` 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 of `this` case execution.
`String`	`getTenantId()` The id of the tenant this case execution belongs to.
`boolean`	`isActive()` Returns `true` if the case execution is active.
`boolean`	`isAvailable()` Returns `true` if the case execution is available.
`boolean`	`isDisabled()` Returns `true` if the case execution is disabled.
`boolean`	`isEnabled()` Returns `true` if the case execution is enabled.
`boolean`	`isRequired()` Returns `true` if the case execution is required.
`boolean`	`isTerminated()` Returns `true` 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 be null if the case execution belongs to no single tenant.

Interface CaseExecution

Method Summary

Method Detail

getId

getCaseInstanceId

getCaseDefinitionId

getActivityId

getActivityName

getActivityType

getActivityDescription

getParentId

isRequired

isAvailable

isActive

isEnabled

isDisabled

isTerminated

getTenantId