com.edorasware.cmmn.model.structure

Class CasePlanModel

java.lang.Object

com.edorasware.cmmn.model.structure.PlanItem

com.edorasware.cmmn.model.structure.Stage

com.edorasware.cmmn.model.structure.CasePlanModel

public class CasePlanModel
extends Stage

A 'Stage' plan item with its associated Stage (TPlanItemDefinition) representing the top-most stage (the casePlanModel) of the case.

<p>Do not rename this class. The name is part of public API. Moving the class to a different package, however, is possible.</p>

Constructor Summary

Constructors

Constructor and Description
CasePlanModel(StateModel stateModel, String clientId, TStage tStage, String parentClientId) Construct a casePlanModel stage.

Method Summary

Modifier and Type	Method and Description
void	applyVisitor(PlanItemVisitor visitor, TransitionData transitionData) Apply a visitor to this stage (GOF visitor pattern).
void	applyVisitor(PlannableItemVisitor visitor, TransitionData transitionData) Apply a plannable item visitor to this stage if it is active.
CasePlanModel	getCasePlanModel() Get the casePlanModel from the parent.
Map<String,String>	getClientProperties()
String	getParentClientId()
String	getParentInstanceId()
String	getPlanItemTypeShort()
StateModel	getStateModel()
Integer	getTriggerLimit()
boolean	isCaseTask()
Boolean	isRepetitionEnabled()
boolean	isRootCaseTask()
boolean	isSubCaseTask()
void	restoreFromExternalState(String id, CasePlanModelData externalState, boolean inMigration) Restore this `PlanItem`'s state from the passed `externalState` object.

Methods inherited from class com.edorasware.cmmn.model.structure.Stage

createPlanItemAction, evaluateApplicabilityRules, evaluateEntryCriteria, evaluateExitCriteria, evaluateStageAutoComplete, findPlanItem, getActiveChildrenCount, getAvailableChildrenCount, getChildInstanceCount, getChildren, getCompletedChildrenCount, getDisabledChildrenCount, getEnabledChildrenCount, getTerminatedChildrenCount, getTriggeredChildrenCount, getTStage, handleDiscretionaryItemPlanning, isAutoComplete, isStageComplete, isWaitingOnChildren, isWaitingOnChildren, needsCompletion, startStage

Methods inherited from class com.edorasware.cmmn.model.structure.PlanItem

getActionDescription, getActionName, getActionName, getActivationTime, getActiveCount, getActiveCountInStage, getArmedEntrySentries, getArmedExitSentries, getAvailableCount, getAvailableCountInStage, getClientId, getClientRef, getCompletedCount, getCompletedCountInStage, getCustomAttribute, getCustomState, getCustomState, getDeferredEntrySentries, getDeferredExitSentries, getDescription, getDisabledCount, getDisabledCountInStage, getEnabledCount, getEnabledCountInStage, getExtensionType, getId, getIndexInStage, getInstanceCount, getInstanceCountInStage, getInstanceId, getInstanceIntId, getLastPlanItemTransition, getName, getName, getName, getNewPlanItemData, getParent, getPlannableItem, getState, getTerminatedCount, getTerminatedCountInStage, getTPlanItemDefinition, getTriggeredCount, getTriggeredCountInStage, getTriggeredExitSentries, handlePlanItemTransition, isActionHidden, isArmed, isBlocking, isCompletionNeutral, isManualActivation, isNonBlockingComplete, isOfSameHierarchy, isPending, isPreActivation, isRepetition, isRequired, isSemiTerminal, isTerminal, isTriggeredExitSentry, setClientId, setCustomState, setCustomState, setState, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CasePlanModel

public CasePlanModel(StateModel stateModel,
                     String clientId,
                     TStage tStage,
                     String parentClientId)

Construct a casePlanModel stage.

Parameters:

stateModel - the state model

clientId - the client id

tStage - the stage

parentClientId - the parent client id

Method Detail

getParentInstanceId

public String getParentInstanceId()

Overrides:

getParentInstanceId in class PlanItem

restoreFromExternalState

public void restoreFromExternalState(String id,
                                     CasePlanModelData externalState,
                                     boolean inMigration)

Description copied from class: PlanItem

Restore this `PlanItem`'s state from the passed `externalState` object.

Overrides:

restoreFromExternalState in class Stage

Parameters:

id - the instance id

externalState - the external state

isRepetitionEnabled

public Boolean isRepetitionEnabled()

getTriggerLimit

public Integer getTriggerLimit()

getCasePlanModel

public CasePlanModel getCasePlanModel()

Description copied from class: PlanItem

Get the casePlanModel from the parent. Climbs up the parent chain to the root (casePlanModel) and returns the root.

Overrides:

getCasePlanModel in class PlanItem

Returns:

itself.

getStateModel

public final StateModel getStateModel()

getPlanItemTypeShort

public String getPlanItemTypeShort()

Overrides:

getPlanItemTypeShort in class Stage

getParentClientId

public final String getParentClientId()

Returns:

the client Id of the parent case. This is null for top-level cases. Contains the client Id of the case’s parent case for cases representing case tasks.

isCaseTask

public boolean isCaseTask()

Returns:

true if this case was created as a result of a case task. Return false otherwise.

isSubCaseTask

public boolean isSubCaseTask()

Returns:

true if this case plan model was created from a case task and is of type sub-case. Returns false otherwise.

isRootCaseTask

public boolean isRootCaseTask()

Returns:

true if this case plan model was created from a case task and is of type root case. Returns false otherwise.

applyVisitor

public void applyVisitor(PlanItemVisitor visitor,
                         TransitionData transitionData)

Description copied from class: Stage

Apply a visitor to this stage (GOF visitor pattern).

Overrides:

applyVisitor in class Stage

Parameters:

visitor - the plan item visitor

transitionData - optional evaluation context.

applyVisitor

public void applyVisitor(PlannableItemVisitor visitor,
                         TransitionData transitionData)

Description copied from class: Stage

Apply a plannable item visitor to this stage if it is active. This runs through the planning table and applies the visitor to the plannable items in the planning table in turn. The method then drills down into the stage’s children.

Overrides:

applyVisitor in class Stage

Parameters:

visitor - the plannable item visitor to apply.

transitionData - optional evaluation context.

getClientProperties

public final Map<String,String> getClientProperties()