Package org.flowable.cmmn.api.event

# Interface FlowableCaseEndedEvent

All Superinterfaces:
  `FlowableEngineEntityEvent`, `FlowableEngineEvent`, `FlowableEntityEvent`, `FlowableEvent`

public interface FlowableCaseEndedEvent extends FlowableEngineEntityEvent
The interface for a case ended event, which might be a case completed or case terminated event.

Author:
  Micha Kiener

- ## Field Summary

  Fields
  Modifier and Type
  Field
  Description
  `static final String`
  `ENDING_STATE_COMPLETED`
  `static final String`
  `ENDING_STATE_TERMINATED`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `String`
  `getEndingState()`
  Returns the ending state of the case which can be `ENDING_STATE_COMPLETED` or `ENDING_STATE_TERMINATED`.
  `CaseInstance`
  `getEntity()`

  ### 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 Details

  - ### 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 Details

  - ### getEndingState

    String getEndingState()
    Returns the ending state of the case which can be `ENDING_STATE_COMPLETED` or `ENDING_STATE_TERMINATED`.
    Returns:
      the ending state of the case

  - ### getEntity

    CaseInstance getEntity()
    Specified by:
      `getEntity` in interface `FlowableEntityEvent`
    Returns:
      the entity that is targeted by this event.