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

Class TerminateCaseInstanceOperation

java.lang.Object

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

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

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

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

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

All Implemented Interfaces:

Runnable

public class TerminateCaseInstanceOperation
extends AbstractDeleteCaseInstanceOperation

Author:

Joram Barrez, Micha Kiener

Field Summary

Fields

Modifier and Type	Field	Description
protected String	exitCriterionId
protected String	exitEventType
protected String	exitType
protected boolean	manualTermination

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

caseInstanceEntity, caseInstanceEntityId

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

commandContext, isNoop

Constructor Summary

Constructors

Constructor	Description
TerminateCaseInstanceOperation(CommandContext commandContext, String caseInstanceId, boolean manualTermination, String exitCriterionId, String exitType, String exitEventType)

Method Summary

Modifier and Type	Method	Description
void	addAdditionalCallbackData(CallbackData callbackData)
void	changeStateForChildPlanItemInstance(PlanItemInstanceEntity planItemInstanceEntity)
protected void	checkCaseToBeCompletable()	Checks, if the case is completable and if not, raises an exception.
CaseInstanceEntity	getCaseInstanceEntity()
String	getDeleteReason()
String	getExitCriterionId()
String	getExitEventType()
String	getExitType()
String	getNewState()
protected void	invokePostLifecycleListeners()	Overwritten in order to send a case end / terminate event through the case engine dispatcher.
boolean	isManualTermination()
void	preRunCheck()	Overridden to check, if the optional exit event type is set to 'complete' and if so, throw an exception, if the case is not yet completable.
void	setExitCriterionId(String exitCriterionId)
void	setExitEventType(String exitEventType)
void	setExitType(String exitType)
void	setManualTermination(boolean manualTermination)

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

deleteCaseInstance, internalExecute, updateChildPlanItemInstancesState

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

invokePreLifecycleListeners, run

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

getCaseInstanceId, setCaseInstanceEntity, setCaseInstanceEntityId

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, toString, wait, wait, wait

Field Detail

manualTermination

protected boolean manualTermination

exitCriterionId

protected String exitCriterionId

exitType

protected String exitType

exitEventType

protected String exitEventType

Constructor Detail

TerminateCaseInstanceOperation

public TerminateCaseInstanceOperation(CommandContext commandContext,
                                      String caseInstanceId,
                                      boolean manualTermination,
                                      String exitCriterionId,
                                      String exitType,
                                      String exitEventType)

Method Detail

preRunCheck

public void preRunCheck()

Overridden to check, if the optional exit event type is set to 'complete' and if so, throw an exception, if the case is not yet completable.

Overrides:

preRunCheck in class AbstractChangeCaseInstanceStateOperation

checkCaseToBeCompletable

protected void checkCaseToBeCompletable()

Checks, if the case is completable and if not, raises an exception.

getNewState

public String getNewState()

Specified by:

getNewState in class AbstractChangeCaseInstanceStateOperation

changeStateForChildPlanItemInstance

public void changeStateForChildPlanItemInstance(PlanItemInstanceEntity planItemInstanceEntity)

Specified by:

changeStateForChildPlanItemInstance in class AbstractChangeCaseInstanceStateOperation

invokePostLifecycleListeners

protected void invokePostLifecycleListeners()

Overwritten in order to send a case end / terminate event through the case engine dispatcher.

Overrides:

invokePostLifecycleListeners in class AbstractChangeCaseInstanceStateOperation

getDeleteReason

public String getDeleteReason()

Specified by:

getDeleteReason in class AbstractDeleteCaseInstanceOperation

addAdditionalCallbackData

public void addAdditionalCallbackData(CallbackData callbackData)

Overrides:

addAdditionalCallbackData in class AbstractDeleteCaseInstanceOperation

getCaseInstanceEntity

public CaseInstanceEntity getCaseInstanceEntity()

Overrides:

getCaseInstanceEntity in class AbstractCaseInstanceOperation

isManualTermination

public boolean isManualTermination()

setManualTermination

public void setManualTermination(boolean manualTermination)

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)