Package org.flowable.cmmn.engine.impl.delegate

Class CmmnClassDelegate

java.lang.Object

org.flowable.cmmn.engine.impl.delegate.CmmnClassDelegate

All Implemented Interfaces:

Serializable, PlanItemVariableAggregator, CaseInstanceLifecycleListener, PlanItemInstanceLifecycleListener, CmmnActivityBehavior, CmmnTriggerableActivityBehavior, BaseTaskListener, TaskListener

Direct Known Subclasses:

ClassDelegateHttpHandler

public class CmmnClassDelegate
extends Object
implements CmmnTriggerableActivityBehavior, TaskListener, PlanItemInstanceLifecycleListener, CaseInstanceLifecycleListener, PlanItemVariableAggregator

Author:

Joram Barrez

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected CmmnActivityBehavior	activityBehaviorInstance
protected String	className
protected List<FieldExtension>	fieldExtensions
protected String	sourceState
protected String	targetState

Fields inherited from interface org.flowable.task.service.delegate.BaseTaskListener

EVENTNAME_ALL_EVENTS, EVENTNAME_ASSIGNMENT, EVENTNAME_COMPLETE, EVENTNAME_CREATE, EVENTNAME_DELETE

Constructor Summary

Constructors

Constructor	Description
CmmnClassDelegate(String className, List<FieldExtension> fieldExtensions)

Method Summary

Modifier and Type	Method	Description
Object	aggregateMultiVariables(DelegatePlanItemInstance planItemInstance, List<? extends VariableInstance> instances, PlanItemVariableAggregatorContext context)	Aggregated the provided variable instances into one variable value.
Object	aggregateSingleVariable(DelegatePlanItemInstance planItemInstance, PlanItemVariableAggregatorContext context)	Create a single variable value based on the provided aggregation definition.
protected static void	applyFieldExtension(FieldExtension fieldExtension, Object target, boolean throwExceptionOnMissingField)
static void	applyFieldExtensions(List<FieldExtension> fieldExtensions, Object target, boolean throwExceptionOnMissingField)
void	execute(DelegatePlanItemInstance planItemInstance)
CmmnActivityBehavior	getActivityBehaviorInstance()
protected CaseInstanceLifecycleListener	getCaseLifeCycleListenerInstance()
String	getClassName()
protected CmmnActivityBehavior	getCmmnActivityBehavior(String className)
List<FieldExtension>	getFieldExtensions()
protected PlanItemInstanceLifecycleListener	getPlanItemLifeCycleListenerInstance()
protected PlanItemVariableAggregator	getPlanItemVariableAggregator()
String	getSourceState()
String	getTargetState()
protected TaskListener	getTaskListenerInstance(DelegateTask delegateTask)
protected Object	instantiate(String className)
void	notify(DelegateTask delegateTask)
void	setActivityBehaviorInstance(CmmnActivityBehavior activityBehaviorInstance)
void	setClassName(String className)
void	setFieldExtensions(List<FieldExtension> fieldExtensions)
void	setSourceState(String sourceState)
void	setTargetState(String targetState)
void	stateChanged(DelegatePlanItemInstance planItemInstance, String oldState, String newState)	Will be called when the state of a DelegatePlanItemInstance changes and the PlanItemInstanceLifecycleListener.getSourceState() and PlanItemInstanceLifecycleListener.getTargetState() match.
void	stateChanged(CaseInstance caseInstance, String oldState, String newState)	Will be called when the state of a CaseInstance changes and the CaseInstanceLifecycleListener.getSourceState() and CaseInstanceLifecycleListener.getTargetState() match.
void	trigger(DelegatePlanItemInstance planItemInstance)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

sourceState

protected String sourceState

targetState

protected String targetState

className

protected String className

fieldExtensions

protected List<FieldExtension> fieldExtensions

activityBehaviorInstance

protected CmmnActivityBehavior activityBehaviorInstance

Constructor Details

CmmnClassDelegate

public CmmnClassDelegate(String className,
 List<FieldExtension> fieldExtensions)

Method Details

execute

public void execute(DelegatePlanItemInstance planItemInstance)

Specified by:

execute in interface CmmnActivityBehavior

trigger

public void trigger(DelegatePlanItemInstance planItemInstance)

Specified by:

trigger in interface CmmnTriggerableActivityBehavior

getCmmnActivityBehavior

protected CmmnActivityBehavior getCmmnActivityBehavior(String className)

notify

public void notify(DelegateTask delegateTask)

Specified by:

notify in interface TaskListener

getTaskListenerInstance

protected TaskListener getTaskListenerInstance(DelegateTask delegateTask)

stateChanged

public void stateChanged(DelegatePlanItemInstance planItemInstance,
 String oldState,
 String newState)

Description copied from interface: PlanItemInstanceLifecycleListener

Will be called when the state of a DelegatePlanItemInstance changes and the PlanItemInstanceLifecycleListener.getSourceState() and PlanItemInstanceLifecycleListener.getTargetState() match.

Specified by:

stateChanged in interface PlanItemInstanceLifecycleListener

stateChanged

public void stateChanged(CaseInstance caseInstance,
 String oldState,
 String newState)

Description copied from interface: CaseInstanceLifecycleListener

Will be called when the state of a CaseInstance changes and the CaseInstanceLifecycleListener.getSourceState() and CaseInstanceLifecycleListener.getTargetState() match.

Specified by:

stateChanged in interface CaseInstanceLifecycleListener

getPlanItemLifeCycleListenerInstance

protected PlanItemInstanceLifecycleListener getPlanItemLifeCycleListenerInstance()

getCaseLifeCycleListenerInstance

protected CaseInstanceLifecycleListener getCaseLifeCycleListenerInstance()

aggregateSingleVariable

public Object aggregateSingleVariable(DelegatePlanItemInstance planItemInstance,
 PlanItemVariableAggregatorContext context)

Description copied from interface: PlanItemVariableAggregator

Create a single variable value based on the provided aggregation definition. This is called after a single repeatable plan item instance is completed, or an overview for a non completed repeatable plan item instance is needed.

Specified by:

aggregateSingleVariable in interface PlanItemVariableAggregator

Parameters:

planItemInstance - the delegate planItemInstance from where we need to get data from

context - the aggregation context

Returns:

the value for the aggregated variable

aggregateMultiVariables

public Object aggregateMultiVariables(DelegatePlanItemInstance planItemInstance,
 List<? extends VariableInstance> instances,
 PlanItemVariableAggregatorContext context)

Description copied from interface: PlanItemVariableAggregator

Aggregated the provided variable instances into one variable value. This is called when all repeatable plan item instances are complete, or an overview for repeatable plan item instances is needed.

Specified by:

aggregateMultiVariables in interface PlanItemVariableAggregator

Parameters:

planItemInstance - the delegated planItemInstance for which we need to do the aggregation

instances - the variable values that should be aggregated (these variables are created based on the value from PlanItemVariableAggregator.aggregateSingleVariable(DelegatePlanItemInstance, PlanItemVariableAggregatorContext))

context - the aggregation context

Returns:

the aggregated value

getPlanItemVariableAggregator

protected PlanItemVariableAggregator getPlanItemVariableAggregator()

instantiate

protected Object instantiate(String className)

applyFieldExtensions

public static void applyFieldExtensions(List<FieldExtension> fieldExtensions,
 Object target,
 boolean throwExceptionOnMissingField)

applyFieldExtension

protected static void applyFieldExtension(FieldExtension fieldExtension,
 Object target,
 boolean throwExceptionOnMissingField)

getSourceState

public String getSourceState()

Specified by:

getSourceState in interface CaseInstanceLifecycleListener

Specified by:

getSourceState in interface PlanItemInstanceLifecycleListener

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.

setSourceState

public void setSourceState(String sourceState)

getTargetState

public String getTargetState()

Specified by:

getTargetState in interface CaseInstanceLifecycleListener

Specified by:

getTargetState in interface PlanItemInstanceLifecycleListener

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.

setTargetState

public void setTargetState(String targetState)

getClassName

public String getClassName()

setClassName

public void setClassName(String className)

getFieldExtensions

public List<FieldExtension> getFieldExtensions()

setFieldExtensions

public void setFieldExtensions(List<FieldExtension> fieldExtensions)

getActivityBehaviorInstance

public CmmnActivityBehavior getActivityBehaviorInstance()

setActivityBehaviorInstance

public void setActivityBehaviorInstance(CmmnActivityBehavior activityBehaviorInstance)