Class FailPlanItemInstanceOperation

java.lang.Object

org.flowable.cmmn.engine.impl.agenda.operation.CmmnOperation

org.flowable.cmmn.engine.impl.agenda.operation.AbstractPlanItemInstanceOperation

org.flowable.cmmn.engine.impl.agenda.operation.AbstractChangePlanItemInstanceStateOperation

org.flowable.cmmn.engine.impl.agenda.operation.AbstractMovePlanItemInstanceToTerminalStateOperation

org.flowable.cmmn.engine.impl.agenda.operation.FailPlanItemInstanceOperation

All Implemented Interfaces:

Runnable

public class FailPlanItemInstanceOperation
extends AbstractMovePlanItemInstanceToTerminalStateOperation

Operation that moves a plan item instance to the PlanItemInstanceState.FAILED state via the PlanItemTransition.FAULT transition. For tasks: children are NOT affected (non-propagating per CMMN 1.1 spec). For stages (when the fault propagates to a stage with a catching sentry): children are terminated via exitChildPlanItemInstances, since the stage is ending as a scope — consistent with BPMN where a subprocess is cleaned up when a boundary error event catches an error.

Author:

Joram Barrez

Field Summary

Fields

Modifier and Type	Field	Description
protected BusinessError	businessError

Fields inherited from class AbstractPlanItemInstanceOperation

planItemInstanceEntity

Fields inherited from class CmmnOperation

commandContext, isNoop

Constructor Summary

Constructors

Constructor	Description
FailPlanItemInstanceOperation(CommandContext commandContext, PlanItemInstanceEntity planItemInstanceEntity)
FailPlanItemInstanceOperation(CommandContext commandContext, PlanItemInstanceEntity planItemInstanceEntity, BusinessError businessError)

Method Summary

Modifier and Type	Method	Description
boolean	abortOperationIfNewStateEqualsOldState()	Overwrite this default implemented hook, if the operation should be aborted on a void transition which might be the case, if the old and new state will be the same.
protected PlanItemLifeCycleEvent	createPlanItemLifeCycleEvent()
protected Map<String,String>	getAsyncLeaveTransitionMetadata()
String	getLifeCycleTransition()
String	getNewState()
String	getOperationName()
protected void	internalExecute()	Implementing classes should be aware that unlike extending from AbstractChangePlanItemInstanceStateOperation, this method will be executed just before the deleting the entity
boolean	isEvaluateRepetitionRule()
protected boolean	shouldAggregateForMultipleInstances()	Whether multi aggregation needs to be done.
protected boolean	shouldAggregateForSingleInstance()	Whether variable aggregation should be done when a single instance completes.

Methods inherited from class AbstractMovePlanItemInstanceToTerminalStateOperation

aggregateVariablesForAllInstances, aggregateVariablesForSingleInstance, exitChildPlanItemInstances, getVariableAggregations, hasMaxInstanceCount, hasRepetitionOnCollection, hasRepetitionRule, hasRepetitionRuleAndNoEntryCriteria, hasRepetitionRuleEntryCriteria, isAsyncLeave, isRepeatingOnDelete, isWaitingForRepetitionPlanItemInstanceExists, isWithoutStageOrParentIsNotTerminated, resolveEventDefinitionKey, run

Methods inherited from class AbstractChangePlanItemInstanceStateOperation

isStateNotChanged, onPlanned, toString

Methods inherited from class AbstractPlanItemInstanceOperation

getCaseInstanceId, getCurrentTime, getPlanItemInstanceEntity, removeSentryRelatedData, setPlanItemInstanceEntity

Methods inherited from class CmmnOperation

childPlanItemInstanceForPlanItemExists, createPlanItemInstanceIfNeeded, createPlanItemInstancesForNewOrReactivatedStage, evaluateReactivationCondition, evaluateReactivationRule, getCaseInstance, getPlanItemCreationOrReactivationType, getPlanModel, getStage, isEventListenerWithAvailableCondition, isNoop, isStage, markAsNoop, setRepetitionCounter

Methods inherited from class Object

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

Field Details

businessError

protected BusinessError businessError

Constructor Details

FailPlanItemInstanceOperation

public FailPlanItemInstanceOperation(CommandContext commandContext,
 PlanItemInstanceEntity planItemInstanceEntity)

FailPlanItemInstanceOperation

public FailPlanItemInstanceOperation(CommandContext commandContext,
 PlanItemInstanceEntity planItemInstanceEntity,
 BusinessError businessError)

Method Details

createPlanItemLifeCycleEvent

protected PlanItemLifeCycleEvent createPlanItemLifeCycleEvent()

Overrides:

createPlanItemLifeCycleEvent in class AbstractChangePlanItemInstanceStateOperation

getNewState

public String getNewState()

Specified by:

getNewState in class AbstractChangePlanItemInstanceStateOperation

getLifeCycleTransition

public String getLifeCycleTransition()

Specified by:

getLifeCycleTransition in class AbstractChangePlanItemInstanceStateOperation

isEvaluateRepetitionRule

public boolean isEvaluateRepetitionRule()

Specified by:

isEvaluateRepetitionRule in class AbstractMovePlanItemInstanceToTerminalStateOperation

shouldAggregateForSingleInstance

protected boolean shouldAggregateForSingleInstance()

Description copied from class: AbstractMovePlanItemInstanceToTerminalStateOperation

Whether variable aggregation should be done when a single instance completes. This does not need to check whether the plan item instance has variable aggregations, that is the same for all instances. e.g. When an instance completes normally we should aggregate the data, but if it terminates we shouldn't

Specified by:

shouldAggregateForSingleInstance in class AbstractMovePlanItemInstanceToTerminalStateOperation

shouldAggregateForMultipleInstances

protected boolean shouldAggregateForMultipleInstances()

Description copied from class: AbstractMovePlanItemInstanceToTerminalStateOperation

Whether multi aggregation needs to be done. This does not need to check whether the plan item instance has variable aggregations, that is the same for all instances. e.g. Multi aggregation needs to be done when we do a normal completion, but not when the plan items are terminated

Specified by:

shouldAggregateForMultipleInstances in class AbstractMovePlanItemInstanceToTerminalStateOperation

internalExecute

protected void internalExecute()

Description copied from class: AbstractMovePlanItemInstanceToTerminalStateOperation

Implementing classes should be aware that unlike extending from AbstractChangePlanItemInstanceStateOperation, this method will be executed just before the deleting the entity

Specified by:

internalExecute in class AbstractMovePlanItemInstanceToTerminalStateOperation

getAsyncLeaveTransitionMetadata

protected Map<String,String> getAsyncLeaveTransitionMetadata()

Specified by:

getAsyncLeaveTransitionMetadata in class AbstractMovePlanItemInstanceToTerminalStateOperation

abortOperationIfNewStateEqualsOldState

public boolean abortOperationIfNewStateEqualsOldState()

Description copied from class: AbstractChangePlanItemInstanceStateOperation

Overwrite this default implemented hook, if the operation should be aborted on a void transition which might be the case, if the old and new state will be the same.

Overrides:

abortOperationIfNewStateEqualsOldState in class AbstractChangePlanItemInstanceStateOperation

Returns:

true, if this operation should be aborted, if the new plan item state is the same as the old one, false, if the operation is to be executed in any case

getOperationName

public String getOperationName()

Specified by:

getOperationName in class AbstractChangePlanItemInstanceStateOperation