com.edorasware.cmmn.model.staticmodel

Class PlannableItem

java.lang.Object

com.edorasware.cmmn.model.staticmodel.PlannableItem

public class PlannableItem
extends Object

<p>This is basically a static model element. Run-time plan item instances always map to a static model element but represent run-time state and introduce an instance ID extension to the model element ID.</p>

<p>A class representing an item that can be planned. It can be instantiated from a TPlanItem or a TDiscretionaryItem or a TStage (in the case of the casePlanModel).</p>

<p>TPlanItem's are considered planed already. TDiscretionaryItem may get planed. A planed item is a child of a stage (see Stage).</p>

Constructor Summary

Constructors

Constructor and Description
PlannableItem(TDiscretionaryItem tDiscretionaryItem, PlannableItem parent) <p>Construct a plannable item based on a TDiscretionaryItem.
PlannableItem(TPlanItem tPlanItem, PlannableItem parent) <p>Construct a 'plannable' item, instantiated from a TPlanItem.
PlannableItem(TStage tStage) <p>Construct the plannable item representing the case plan model when only the static model structure is needed and no run-time state is available.
PlannableItem(TStage tStage, StateModel stateModel) <p>Use only for the Case’s implicit top-level stage!

Method Summary

Modifier and Type	Method and Description
void	applyVisitor(PlannableItemVisitor visitor, TransitionData transitionData) Apply a visitor to this plannable item (GOF visitor pattern).
int	commonStagePathLength(PlannableItem[] otherPath)
boolean	evaluateApplicabilityRules(TransitionData transitionData, PlanningListeners planningListeners, EvaluationListeners evaluationListeners)
String	getActionDescription()
String	getActionGroups()
String	getActionGroups(TransitionData transitionData, EvaluationListeners evaluationListeners)
String	getActionName()
String	getActionName(Locale locale)
String	getActionName(PlanItem evaluationContext, TransitionData transitionData, EvaluationListeners evaluationListeners)
int	getActionOrder()
String	getActionUsers()
String	getActionUsers(TransitionData transitionData, EvaluationListeners evaluationListeners)
String	getCustomAttribute(String name) Get the value of a named custom attribute.
HashMap<String,String>	getCustomAttributes()
String	getDescription()
List<Sentry>	getEntryCriteria()
List<Sentry>	getExitCriteria()
String	getExtensionType()
String	getHideActionIf()
String	getId()
List<Sentry>	getListenerSentries()
Rule	getManualActivationRule()
String	getName()
String	getName(Locale locale)
String	getName(PlanItem evaluationContext, TransitionData transitionData, EvaluationListeners evaluationListeners)
PlannableItem	getParent()
HashMap<String,PlanItem>	getPlanItemsByInstanceId()
Class<? extends PlanItem>	getPlanItemType()
Rule	getRepetitionRule()
Rule	getRequiredRule()
PlannableItem[]	getStagePath()
StateModel	getStateModel()
String	getStateVisible()
TPlanItemDefinition	getTPlanItemDefinition()
int	getVisualizationOrder()
boolean	hasOnPart()
boolean	isAvailableForPlanning()
boolean	isBlocking() <p>The 'blocking' property applies to tasks (human task, process task, case task).
boolean	isCasePlanModel()
boolean	isEventListener()
void	registerNewInstance(PlanItem planItem) Register the passed planItem instance with its plannable item and the state model.
void	resetListeners() The listenerSentries array is cached.
void	setAvailableForPlanning(boolean availableForPlanning)
void	setParent(PlannableItem parent)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PlannableItem

public PlannableItem(TStage tStage,
                     StateModel stateModel)

<p>Use only for the Case’s implicit top-level stage!</p>

<p>The current version of the XSD and hence the generated XML doesn’t allow for a top level TPlanItem corresponding to the casePlanModel (TStage) itself. To remedy this, for the top-level casePlanModel, a PlannableItem is created here with just its tStage.</p>

Parameters:

tStage - the stage

stateModel - the state model

PlannableItem

public PlannableItem(TPlanItem tPlanItem,
                     PlannableItem parent)

<p>Construct a 'plannable' item, instantiated from a TPlanItem.</p>

Parameters:

tPlanItem - the plan item

parent - the parent plannable item

PlannableItem

public PlannableItem(TDiscretionaryItem tDiscretionaryItem,
                     PlannableItem parent)

<p>Construct a plannable item based on a TDiscretionaryItem.</p>. If the plannable item has applicability rules, it becomes plannable as soon as the applicability rules fire. If there are no applicability rules, the item is immediately plannable.

Parameters:

tDiscretionaryItem - the discretionary item

parent - the parent plannable item

PlannableItem

public PlannableItem(TStage tStage)

<p>Construct the plannable item representing the case plan model when only the static model structure is needed and no run-time state is available.</p>.

<p>Currently only used during migration of state models.</p>

Method Detail

setParent

public void setParent(PlannableItem parent)

Parameters:

parent - the parent plannable item

isEventListener

public boolean isEventListener()

Returns:

true if this plannable item represents an event listener. false otherwise.

evaluateApplicabilityRules

public boolean evaluateApplicabilityRules(TransitionData transitionData,
                                          PlanningListeners planningListeners,
                                          EvaluationListeners evaluationListeners)

Parameters:

planningListeners - the planning listeners

Returns:

true if its 'availableForPlanning' property changed. Return false otherwise.

getPlanItemsByInstanceId

public HashMap<String,PlanItem> getPlanItemsByInstanceId()

registerNewInstance

public void registerNewInstance(PlanItem planItem)

Register the passed planItem instance with its plannable item and the state model.

Parameters:

planItem - the plan item to register.

getCustomAttribute

public String getCustomAttribute(String name)

Get the value of a named custom attribute.

Parameters:

name - the name of the attribute.

Returns:

the string value of the attribute. May be null.

getCustomAttributes

public HashMap<String,String> getCustomAttributes()

getExtensionType

public String getExtensionType()

getHideActionIf

public String getHideActionIf()

getStateVisible

public String getStateVisible()

getVisualizationOrder

public int getVisualizationOrder()

getActionOrder

public int getActionOrder()

getId

public final String getId()

Returns:

the id

getName

public String getName()

Returns:

the name

getName

public String getName(Locale locale)

Parameters:

locale - the required locale

Returns:

the localized name

getActionName

public String getActionName()

getActionName

public String getActionName(Locale locale)

getName

public String getName(PlanItem evaluationContext,
                      TransitionData transitionData,
                      EvaluationListeners evaluationListeners)

getActionName

public String getActionName(PlanItem evaluationContext,
                            TransitionData transitionData,
                            EvaluationListeners evaluationListeners)

getDescription

public String getDescription()

Returns:

the description

getActionDescription

public String getActionDescription()

getActionUsers

public String getActionUsers()

getActionUsers

public String getActionUsers(TransitionData transitionData,
                             EvaluationListeners evaluationListeners)

getActionGroups

public String getActionGroups()

getActionGroups

public String getActionGroups(TransitionData transitionData,
                              EvaluationListeners evaluationListeners)

getPlanItemType

public Class<? extends PlanItem> getPlanItemType()

getParent

public PlannableItem getParent()

Returns:

the parent plannable item

getListenerSentries

public List<Sentry> getListenerSentries()

Returns:

the list of sentries that have a plan item on-part to this plannable item.

resetListeners

public void resetListeners()

The listenerSentries array is cached. It is created in a lazy fashion and returned afterwards on successive calls. However, each time a new stage is started, new PlannableItems may potentially be added to the plannable items pool with the effect that the list of listenerSentries may also grow. This method is called at the time a new stage is started, forcing the re-calculation of this array when requested the next time.

applyVisitor

public void applyVisitor(PlannableItemVisitor visitor,
                         TransitionData transitionData)

Apply a visitor to this plannable item (GOF visitor pattern).

Parameters:

visitor - the plannable item visitor.

getStateModel

public StateModel getStateModel()

isCasePlanModel

public boolean isCasePlanModel()

getRepetitionRule

public Rule getRepetitionRule()

Returns:

the repetition rule

getRequiredRule

public Rule getRequiredRule()

Returns:

the required rule

getManualActivationRule

public Rule getManualActivationRule()

Returns:

the manual activation rule

getTPlanItemDefinition

public TPlanItemDefinition getTPlanItemDefinition()

Returns:

the plan item definition

isAvailableForPlanning

public boolean isAvailableForPlanning()

Returns:

true if it is available for planning, false otherwise

setAvailableForPlanning

public void setAvailableForPlanning(boolean availableForPlanning)

getEntryCriteria

public List<Sentry> getEntryCriteria()

hasOnPart

public boolean hasOnPart()

getExitCriteria

public List<Sentry> getExitCriteria()

isBlocking

public boolean isBlocking()

<p>The 'blocking' property applies to tasks (human task, process task, case task). The default is true meaning that the life-cycle of the task is managed by the case engine.</p>

<p>The lifecycle of non-blocking tasks is not managed by the case engine. Once a non-blocking task is started, it is immediately completed from the point of view of the case engine.</p>

Returns:

true if this plannable item is not a task or the task is 'blocking', i.e. has its 'blocking' attribute set to true. Return false otherwise.

getStagePath

public PlannableItem[] getStagePath()

Returns:

the path of parent stages, including 'this' if it is a stage.

commonStagePathLength

public int commonStagePathLength(PlannableItem[] otherPath)

toString

public String toString()

Overrides:

toString in class Object