org.flowable.cmmn.api.listener

Interface PlanItemInstanceLifeCycleListener

public interface PlanItemInstanceLifeCycleListener

[Experimental] An interface for listener implementations that get notified when the state of a plan item instance changes. The listener can be registered in the configuration of the engine.

Author:

Joram Barrez

Method Summary

Modifier and Type	Method and Description
List<String>	getItemDefinitionTypes()
String	getSourceState()
String	getTargetState()
void	stateChanged(PlanItemInstance planItemInstance, String oldState, String newState) Will be called when the state of a PlanItemInstance changes, if the getItemDefinitionTypes() and the getSourceState() and getTargetState() match.

Method Detail

getItemDefinitionTypes

List<String> getItemDefinitionTypes()

Returns:

The list of types (from org.flowable.cmmn.api.runtime.PlanItemDefinitionType) this listener listens for. If an empty list or null is returned, all types will be assumed.

getSourceState

String getSourceState()

Returns:

The type a plan item instance is changing from, use a value from PlanItemInstanceState. This listener will only receive elements where the state changing from this value to another one. Return null or the empty String to listen to any state.

getTargetState

String getTargetState()

Returns:

The type a plan item instance is changing to, use a value from PlanItemInstanceState. This listener will only receive elements where the state changing from this value to another one. Return null or the empty String to listen to any state.

stateChanged

void stateChanged(PlanItemInstance planItemInstance,
                  String oldState,
                  String newState)

Will be called when the state of a PlanItemInstance changes, if the getItemDefinitionTypes() and the getSourceState() and getTargetState() match.