FlowableCaseStageEndedEvent (Flowable - CMMN API 6.8.0 API)

All Superinterfaces:

org.flowable.common.engine.api.delegate.event.FlowableEngineEntityEvent, org.flowable.common.engine.api.delegate.event.FlowableEngineEvent, org.flowable.common.engine.api.delegate.event.FlowableEntityEvent, org.flowable.common.engine.api.delegate.event.FlowableEvent
```
public interface FlowableCaseStageEndedEvent
extends org.flowable.common.engine.api.delegate.event.FlowableEngineEntityEvent
```
An event representing a CMMN case stage being ended either manually through termination or with an exit sentry or by completing it.

Author:

Micha Kiener

Field Summary

Fields
Modifier and Type Field Description

static String ENDING_STATE_COMPLETED

static String ENDING_STATE_TERMINATED

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`CaseInstance`	`getCaseInstance()`	Returns the case instance the stage belongs to.
`String`	`getEndingState()`	Returns the ending state of the case stage which can be `ENDING_STATE_COMPLETED` or `ENDING_STATE_TERMINATED`.
`PlanItemInstance`	`getEntity()`	Overwritten in order to return the stage plan item instance.

Methods inherited from interface org.flowable.common.engine.api.delegate.event.FlowableEngineEvent
getExecutionId, getProcessDefinitionId, getProcessInstanceId, getScopeDefinitionId, getScopeId, getScopeType, getSubScopeId

Methods inherited from interface org.flowable.common.engine.api.delegate.event.FlowableEvent
getType

- Field Detail
  - ENDING_STATE_COMPLETED
```
static final String ENDING_STATE_COMPLETED
```
    See Also:
    
    Constant Field Values
  - ENDING_STATE_TERMINATED
```
static final String ENDING_STATE_TERMINATED
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getEndingState
```
String getEndingState()
```
    Returns the ending state of the case stage which can be ENDING_STATE_COMPLETED or ENDING_STATE_TERMINATED.
    
    Returns:
    
    the ending state of the stage
  - getCaseInstance
```
CaseInstance getCaseInstance()
```
    Returns the case instance the stage belongs to.
    
    Returns:
    
    the case instance
  - getEntity
```
PlanItemInstance getEntity()
```
    Overwritten in order to return the stage plan item instance.
    
    Specified by:
    
    getEntity in interface org.flowable.common.engine.api.delegate.event.FlowableEntityEvent
    
    Returns:
    
    the stage plan item instance