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

Class ExitPlanItemInstanceOperation

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.ExitPlanItemInstanceOperation

All Implemented Interfaces:

Runnable

public class ExitPlanItemInstanceOperation
extends AbstractMovePlanItemInstanceToTerminalStateOperation

Author:

Joram Barrez, Micha Kiener

Field Summary

Fields

Modifier and Type	Field	Description
protected String	exitCriterionId
protected String	exitEventType
protected String	exitType
protected Boolean	isStage

Fields inherited from class org.flowable.cmmn.engine.impl.agenda.operation.AbstractPlanItemInstanceOperation

planItemInstanceEntity

Fields inherited from class org.flowable.cmmn.engine.impl.agenda.operation.CmmnOperation

commandContext, isNoop

Constructor Summary

Constructors

Constructor	Description
ExitPlanItemInstanceOperation(CommandContext commandContext, PlanItemInstanceEntity planItemInstanceEntity, String exitCriterionId, String exitType, String exitEventType)

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 Map<String,String>	getAsyncLeaveTransitionMetadata()
String	getExitCriterionId()
String	getExitEventType()
String	getExitType()
String	getLifeCycleTransition()
String	getNewState()
String	getOperationName()
Boolean	getStage()
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()
boolean	isStage()
void	setExitCriterionId(String exitCriterionId)
void	setExitEventType(String exitEventType)
void	setExitType(String exitType)
void	setStage(Boolean stage)
protected boolean	shouldAggregateForMultipleInstances()	Whether multi aggregation needs to be done.
protected boolean	shouldAggregateForSingleInstance()	Whether variable aggregation should be done when a single instance completes.
boolean	shouldPlanItemStayInCurrentState()
boolean	shouldStageGoIntoCompletedState()

Methods inherited from class org.flowable.cmmn.engine.impl.agenda.operation.AbstractMovePlanItemInstanceToTerminalStateOperation

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

Methods inherited from class org.flowable.cmmn.engine.impl.agenda.operation.AbstractChangePlanItemInstanceStateOperation

createPlanItemLifeCycleEvent, isStateNotChanged, toString

Methods inherited from class org.flowable.cmmn.engine.impl.agenda.operation.AbstractPlanItemInstanceOperation

getCaseInstanceId, getCurrentTime, getPlanItemInstanceEntity, removeSentryRelatedData, setPlanItemInstanceEntity

Methods inherited from class org.flowable.cmmn.engine.impl.agenda.operation.CmmnOperation

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

Methods inherited from class java.lang.Object

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

Field Details

exitCriterionId

protected String exitCriterionId

exitType

protected String exitType

exitEventType

protected String exitEventType

isStage

protected Boolean isStage

Constructor Details

ExitPlanItemInstanceOperation

public ExitPlanItemInstanceOperation(CommandContext commandContext,
 PlanItemInstanceEntity planItemInstanceEntity,
 String exitCriterionId,
 String exitType,
 String exitEventType)

Method Details

getNewState

public String getNewState()

Specified by:

getNewState in class AbstractChangePlanItemInstanceStateOperation

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

shouldStageGoIntoCompletedState

public boolean shouldStageGoIntoCompletedState()

Returns:

true, if this plan item is a stage and according the exit sentry exit event type needs to go in complete state instead of terminated

shouldPlanItemStayInCurrentState

public boolean shouldPlanItemStayInCurrentState()

getLifeCycleTransition

public String getLifeCycleTransition()

Specified by:

getLifeCycleTransition in class AbstractChangePlanItemInstanceStateOperation

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

isEvaluateRepetitionRule

public boolean isEvaluateRepetitionRule()

Specified by:

isEvaluateRepetitionRule in class AbstractMovePlanItemInstanceToTerminalStateOperation

getAsyncLeaveTransitionMetadata

protected Map<String,String> getAsyncLeaveTransitionMetadata()

Specified by:

getAsyncLeaveTransitionMetadata 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

isStage

public boolean isStage()

getOperationName

public String getOperationName()

Specified by:

getOperationName in class AbstractChangePlanItemInstanceStateOperation

getExitCriterionId

public String getExitCriterionId()

setExitCriterionId

public void setExitCriterionId(String exitCriterionId)

getExitType

public String getExitType()

setExitType

public void setExitType(String exitType)

getExitEventType

public String getExitEventType()

setExitEventType

public void setExitEventType(String exitEventType)

getStage

public Boolean getStage()

setStage

public void setStage(Boolean stage)