Package org.flowable.cmmn.api.event

Interface FlowableCaseStageEndedEvent

All Superinterfaces:

FlowableEngineEntityEvent, FlowableEngineEvent, FlowableEntityEvent, FlowableEvent

public interface FlowableCaseStageEndedEvent
extends 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 final String	ENDING_STATE_COMPLETED
static final String	ENDING_STATE_TERMINATED

Method Summary

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 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 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 FlowableEntityEvent

Returns:

the stage plan item instance