PlanItem (edoras one Java API (2.0.7))

java.lang.Object
- com.edorasware.cmmn.model.structure.PlanItem

Direct Known Subclasses:

EventListener, Milestone, Stage, Task
```
public abstract class PlanItem
extends Object
```
A typed plan item. It is the combination of a PlanItem (CMMN model) and its associated TPlanItemDefinition. Do not rename this class. The name is part of public API. Moving the class to a different package, however, is possible.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`applyVisitor(PlannableItemVisitor visitor, TransitionData transitionData)` Apply a plannable item visitor to this plan item.
`PlanItemAction`	`createPlanItemAction(TransitionData transitionData, EvaluationListeners evaluationListeners)` <p>Create an action object for the current state of this plan item.
`String`	`getActionDescription()`
`String`	`getActionName()`
`String`	`getActionName(TransitionData transitionData, EvaluationListeners evaluationListeners)`
`String`	`getActivationTime()` The Java timestamp of the moment the plan item transitioned to ACTIVE.
`int`	`getActiveChildrenCount()`
`int`	`getActiveCount()`
`int`	`getActiveCountInStage()`
`Map<String,Sentry>`	`getArmedEntrySentries(TransitionData transitionData, EvaluationListeners evaluationListeners)`
`Map<String,Sentry>`	`getArmedExitSentries(TransitionData transitionData, EvaluationListeners evaluationListeners)`
`int`	`getAvailableChildrenCount()`
`int`	`getAvailableCount()`
`int`	`getAvailableCountInStage()`
`CasePlanModel`	`getCasePlanModel()` Get the `casePlanModel` from the parent.
`int`	`getChildInstanceCount()`
`String`	`getClientId()`
`String`	`getClientRef()` Default implementation returning `null`.
`int`	`getCompletedChildrenCount()`
`int`	`getCompletedCount()`
`int`	`getCompletedCountInStage()`
`String`	`getCustomAttribute(String name)`
`Map<String,String>`	`getCustomState()`
`String`	`getCustomState(String key)` Retrieve a custom state value for the passed key.
`Map<String,Sentry>`	`getDeferredEntrySentries()`
`Map<String,Sentry>`	`getDeferredExitSentries()`
`String`	`getDescription()`
`int`	`getDisabledChildrenCount()`
`int`	`getDisabledCount()`
`int`	`getDisabledCountInStage()`
`int`	`getEnabledChildrenCount()`
`int`	`getEnabledCount()`
`int`	`getEnabledCountInStage()`
`String`	`getExtensionType()`
`String`	`getId()`
`int`	`getIndexInStage()`
`int`	`getInstanceCount()`
`int`	`getInstanceCountInStage()`
`String`	`getInstanceId()`
`int`	`getInstanceIntId()`
`PlanItemTransition`	`getLastPlanItemTransition()`
`String`	`getName()`
`String`	`getName(Locale locale)`
`String`	`getName(TransitionData transitionData, EvaluationListeners evaluationListeners)`
`PlanItemData`	`getNewPlanItemData()` Ceate and return a new `PlanItemData` instance representing the current state of this object (for the purpose to save and later restore it).
`Stage`	`getParent()`
`String`	`getParentInstanceId()`
`String`	`getPlanItemTypeShort()`
`PlannableItem`	`getPlannableItem()`
`PlanItemState`	`getState()`
`int`	`getTerminatedChildrenCount()`
`int`	`getTerminatedCount()`
`int`	`getTerminatedCountInStage()`
`TPlanItemDefinition`	`getTPlanItemDefinition()`
`int`	`getTriggeredChildrenCount()`
`int`	`getTriggeredCount()`
`int`	`getTriggeredCountInStage()`
`ArrayList<String>`	`getTriggeredExitSentries()`
`void`	`handlePlanItemTransition(PlanItemTransition planItemTransition, TransitionData transitionData, EventSources eventSources, EngineListeners engineListeners, PersistenceListeners persistenceListeners)` Handle the given `planItemTransition`.
`boolean`	`isActionHidden(TransitionData transitionData, EvaluationListeners evaluationListeners)` Implements https://jira.edorasware.com/browse/CLD-8130
`boolean`	`isArmed(TransitionData transitionData, EvaluationListeners evaluationListeners)`
`boolean`	`isBlocking()` See `PlannableItem.isBlocking()`.
`Boolean`	`isCompletionNeutral()` Get the value of the completionNeutral property on the plan item definition.
`boolean`	`isManualActivation(TransitionData transitionData, EvaluationListeners evaluationListeners)` Note: Referring to figure 5.12 in the spec, a missing manual activation rule should evaluate to 'true' (i.e. manual activation).
`boolean`	`isNonBlockingComplete()`
`boolean`	`isOfSameHierarchy(PlanItem sentryOwner, boolean isExitSentry)` <p>Test if the passed plan item lives in the same run-time stage hierarchy as this plan item.
`boolean`	`isPending()` Either AVAILABLE or ENABLED - The state of being not yet triggered.
`boolean`	`isPreActivation()`
`boolean`	`isRepetition(TransitionData transitionData, EvaluationListeners evaluationListeners)`
`boolean`	`isRequired(TransitionData transitionData, EvaluationListeners evaluationListeners)`
`boolean`	`isSemiTerminal()`
`boolean`	`isTerminal()`
`boolean`	`isTriggeredExitSentry(String id)`
`boolean`	`isWaitingOnChildren(boolean stageAutoComplete, TransitionData transitionData, EvaluationListeners evaluationListeners)`
`boolean`	`isWaitingOnChildren(TransitionData transitionData, EvaluationListeners evaluationListeners)`
`void`	`setClientId(String clientId)`
`void`	`setCustomState(String key, String value)` Store a value under the given key in the plan item’s custom state map.
`void`	`setCustomState(String key, String value, boolean overwrite)` Store a value under the given key in the plan item’s custom state map.
`void`	`setState(PlanItemState state)`
`String`	`toString()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
 - handlePlanItemTransition
```
public void handlePlanItemTransition(PlanItemTransition planItemTransition,
 TransitionData transitionData,
 EventSources eventSources,
 EngineListeners engineListeners,
 PersistenceListeners persistenceListeners)
```
 Handle the given planItemTransition.
 
 Parameters:
 
 planItemTransition - the plan item transition to handle.
 
 transitionData - the transition data
 
 eventSources - the event sources
 
 engineListeners - the engine listener implementation that is used to pass the transition on to client code once any internal state change has been performed.
 - getNewPlanItemData
```
public PlanItemData getNewPlanItemData()
```
 Ceate and return a new PlanItemData instance representing the current state of this object (for the purpose to save and later restore it).
 
 Returns:
 
 the plan item data
 - getParentInstanceId
```
public String getParentInstanceId()
```
 - getArmedEntrySentries
```
public Map<String,Sentry> getArmedEntrySentries(TransitionData transitionData,
 EvaluationListeners evaluationListeners)
```
 Returns:
 
 the entry sentries whose condition is either missing or true. Returns an empty map for a plan item that has already been fired. The map is keyed by sentry model ID.
 - getDeferredEntrySentries
```
public Map<String,Sentry> getDeferredEntrySentries()
```
 Returns:
 
 the entry sentries whose on-parts have triggered. Returns an empty map for a plan item that has already been fired. Never includes sentries with trigger mode 'On event' or no on-parts. The map is keyed by sentry model ID.
 - getArmedExitSentries
```
public Map<String,Sentry> getArmedExitSentries(TransitionData transitionData,
 EvaluationListeners evaluationListeners)
```
 Returns:
 
 the exit sentries whose condition is either missing or true. Returns an empty map for a plan item that has not yet been created or is terminal. The map is keyed by sentry model ID.
 - getDeferredExitSentries
```
public Map<String,Sentry> getDeferredExitSentries()
```
 Returns:
 
 the exit sentries whose on-parts have triggered. Returns an empty map for a plan item that has not yet been created or is terminal. Never includes sentries with trigger mode 'On event' or no on-parts. The map is keyed by sentry model ID.
 - isArmed
```
public boolean isArmed(TransitionData transitionData,
 EvaluationListeners evaluationListeners)
```
 Returns:
 
 true if this plan item is armed. For a plan item with entry sentries this means that the plan item is in state AVAILABLE and one or more of the plan item’s entry sentry (or sentries) are armed (See getArmedEntrySentries(TransitionData, EvaluationListeners)). For an event listener, armed means that invoking the OCCUR transition on the event listener has an effect, i.e. it triggers a transition on one or more connected plan items.
 - isOfSameHierarchy
```
public boolean isOfSameHierarchy(PlanItem sentryOwner,
 boolean isExitSentry)
```
 Test if the passed plan item lives in the same run-time stage hierarchy as this plan item. The test is done by comparing stage hierarchy paths. Both paths are calculated and then compared to each other. The comparison succeeds if the run-time paths match from the case plan model down to the level of the two plan item’s common static model stage path.
 
 Parameters:
 
 sentryOwner - the plan item owning the sentry
 
 isExitSentry - whether the sentry is an exit sentry (false → entry sentry)
 - isTriggeredExitSentry
```
public boolean isTriggeredExitSentry(String id)
```
 - isManualActivation
```
public boolean isManualActivation(TransitionData transitionData,
 EvaluationListeners evaluationListeners)
```
 Note: Referring to figure 5.12 in the spec, a missing manual activation rule should evaluate to 'true' (i.e. manual activation). Thus a missing manual activation simbol in the model for a plan item (resulting in no manual activation expression) leads to a manual activation value of 'true'. This semantic is different from both, the repetition rule handling and the required rule handling. In order to treat them all the same, the code here treats a missing manual activation rule as false, i.e. automatic activation.
 
 Parameters:
 
 transitionData - optional evaluation context
 
 evaluationListeners - the evaluation listeners
 
 Returns:
 
 true if there is a manual activation rule for the plan item and if so it evaluates to true. Return false otherwise.
 - isRepetition
```
public boolean isRepetition(TransitionData transitionData,
 EvaluationListeners evaluationListeners)
```
 Parameters:
 
 transitionData - optional evaluation context
 
 evaluationListeners - the evaluation listeners
 
 Returns:
 
 true if there is a repdtition rule for the plan item and if so it evaluates to true. Return false otherwise.
 - isRequired
```
public boolean isRequired(TransitionData transitionData,
 EvaluationListeners evaluationListeners)
```
 Parameters:
 
 transitionData - optional evaluation context
 
 evaluationListeners - the evaluation listeners
 
 Returns:
 
 true if there is a required rule for the plan item and if so it evaluates to true. Return false otherwise.
 - isCompletionNeutral
```
public Boolean isCompletionNeutral()
```
 Get the value of the completionNeutral property on the plan item definition. A missing property means false.
 - isBlocking
```
public boolean isBlocking()
```
 See PlannableItem.isBlocking().
 
 Returns:
 
 true if it is a blocking plan item
 - isNonBlockingComplete
```
public boolean isNonBlockingComplete()
```
 Returns:
 
 true`If this is a non-blocking plan item which is in state COMPLETED (the state it automatically gets as a result of starting it. Return `false otherwise.
 - isTerminal
```
public boolean isTerminal()
```
 - isSemiTerminal
```
public boolean isSemiTerminal()
```
 - isPreActivation
```
public boolean isPreActivation()
```
 Returns:
 
 true if the plan item has never been activated state (available, enabled, disabled, expired). false otherwise.
 - isPending
```
public boolean isPending()
```
 Either AVAILABLE or ENABLED - The state of being not yet triggered.
 - getAvailableCount
```
public int getAvailableCount()
```
 Returns:
 
 the number of instances of this plan item type that are available.
 - getAvailableCountInStage
```
public int getAvailableCountInStage()
```
 Returns:
 
 the number of instances of this plan item type that are available within the plan item’s stage.
 - getAvailableChildrenCount
```
public int getAvailableChildrenCount()
```
 Returns:
 
 the number of instances of available plan items in this stage.
 - getActiveCount
```
public int getActiveCount()
```
 Returns:
 
 the number of instances of this plan item type that are active.
 - getActiveCountInStage
```
public int getActiveCountInStage()
```
 Returns:
 
 the number of instances of this plan item type that are active within the plan item’s stage.
 - getActiveChildrenCount
```
public int getActiveChildrenCount()
```
 Returns:
 
 the number of instances of active plan items in this stage.
 - getTriggeredCount
```
public int getTriggeredCount()
```
 Returns:
 
 the number of instances of this plan item type that have been triggered.
 - getTriggeredCountInStage
```
public int getTriggeredCountInStage()
```
 Returns:
 
 the number of instances of this plan item type that have been triggered (START, MANUAL_START or OCCUR) within the plan item’s stage.
 - getTriggeredChildrenCount
```
public int getTriggeredChildrenCount()
```
 Returns:
 
 the number of instances of triggered plan items in this stage. Return 0 when called on a non stage plan item.
 - getCompletedCount
```
public int getCompletedCount()
```
 Returns:
 
 the number of instances of this plan item type that are have been completed.
 - getCompletedCountInStage
```
public int getCompletedCountInStage()
```
 Returns:
 
 the number of instances of this plan item type that have completed within the plan item’s stage.
 - getCompletedChildrenCount
```
public int getCompletedChildrenCount()
```
 Returns:
 
 the number of instances of completedplan items in this stage. Return 0 when called on a non stage plan item.
 - getTerminatedCount
```
public int getTerminatedCount()
```
 Returns:
 
 the number of instances of this plan item type that have been terminated.
 - getTerminatedCountInStage
```
public int getTerminatedCountInStage()
```
 Returns:
 
 the number of instances of this plan item type that have been terminated within the plan item’s stage.
 - getTerminatedChildrenCount
```
public int getTerminatedChildrenCount()
```
 Returns:
 
 the number of instances of terminated plan items in this stage. Return 0 when called on a non stage plan item.
 - getEnabledCount
```
public int getEnabledCount()
```
 Returns:
 
 the number of instances of this plan item type that have been enabled.
 - getEnabledCountInStage
```
public int getEnabledCountInStage()
```
 Returns:
 
 the number of instances of this plan item type that are enabled within the plan item’s stage.
 - getEnabledChildrenCount
```
public int getEnabledChildrenCount()
```
 Returns:
 
 the number of instances of enabled plan items in this stage. Return 0 when called on a non stage plan item.
 - getDisabledCount
```
public int getDisabledCount()
```
 Returns:
 
 the number of instances of this plan item type that have been disabled.
 - getDisabledCountInStage
```
public int getDisabledCountInStage()
```
 Returns:
 
 the number of instances of this plan item type that are disabled within the plan item’s stage.
 - getDisabledChildrenCount
```
public int getDisabledChildrenCount()
```
 Returns:
 
 the number of instances of disabled plan items in this stage. Return 0 when called on a non stage plan item.
 - getInstanceCount
```
public int getInstanceCount()
```
 Returns:
 
 the number of instances of this plan item type.
 - getInstanceCountInStage
```
public int getInstanceCountInStage()
```
 Returns:
 
 the number of instances of this plan item within the plan item’s stage.
 - getChildInstanceCount
```
public int getChildInstanceCount()
```
 Returns:
 
 the number of plan item instances in this stage. Return 0 when called on a non stage plan item.
 - getIndexInStage
```
public int getIndexInStage()
```
 Returns:
 
 a sequential index >= 1 enumerating the instances of this plan item within its parent stage. The bigger the index, the younger the plan item instance.
 - isWaitingOnChildren
```
public boolean isWaitingOnChildren(TransitionData transitionData,
 EvaluationListeners evaluationListeners)
```
 Returns:
 
 true if this stage plan item is waiting on its children in order to complete. Return `false> otherwise or when called on a non stage plan item.
 - isWaitingOnChildren
```
public boolean isWaitingOnChildren(boolean stageAutoComplete,
 TransitionData transitionData,
 EvaluationListeners evaluationListeners)
```
 Returns:
 
 true if this stage plan item is waiting on its children in order to complete (under the scenario that the stage’s auto-complete property has the value as passed in the method parameter). Return `false> otherwise or when called on a non stage plan item.
 - getId
```
public final String getId()
```
 Returns:
 
 the id property of this plan item’s PlannableItem. This is the model Id.
 - getInstanceId
```
public final String getInstanceId()
```
 Returns:
 
 the instanceId property of this plan item. This is the model Id appended by '~' and an integer instance suffix.
 - getInstanceIntId
```
public final int getInstanceIntId()
```
 Returns:
 
 the plan item’s instance Id suffix. See getInstanceId().
 - createPlanItemAction
```
public PlanItemAction createPlanItemAction(TransitionData transitionData,
 EvaluationListeners evaluationListeners)
```
 Create an action object for the current state of this plan item. For example, a user event listener in state Available should return an action triggering the 'occur' transition. These actions won’t be immediately executed. They are used to render appropriate GUI elements triggering the action based on the user clicking the action button.
 
 Parameters:
 
 transitionData - optional evaluation context.
 
 evaluationListeners - the call-backs used to evaluate run-time action name expressions.
 
 Returns:
 
 the action object for the current state of the plan item. The default implementation returns null.
 - isActionHidden
```
public boolean isActionHidden(TransitionData transitionData,
 EvaluationListeners evaluationListeners)
```
 Implements https://jira.edorasware.com/browse/CLD-8130
 - getTriggeredExitSentries
```
public ArrayList<String> getTriggeredExitSentries()
```
 - getPlannableItem
```
public PlannableItem getPlannableItem()
```
 - getName
```
public String getName()
```
 Returns:
 
 the name property of this plan item’s PlannableItem.
 - getName
```
public String getName(Locale locale)
```
 Parameters:
 
 locale - the required locale
 
 Returns:
 
 the name property of this plan item’s PlannableItem.
 - getName
```
public String getName(TransitionData transitionData,
 EvaluationListeners evaluationListeners)
```
 - getActionName
```
public String getActionName()
```
 - getActionName
```
public String getActionName(TransitionData transitionData,
 EvaluationListeners evaluationListeners)
```
 - getDescription
```
public String getDescription()
```
 Returns:
 
 the description property of this plan item’s PlannableItem.
 - getActionDescription
```
public String getActionDescription()
```
 - getActivationTime
```
public String getActivationTime()
```
 The Java timestamp of the moment the plan item transitioned to ACTIVE. May be null if not yet activated or if not applicable to the plan item type (e.g. event listeners).
 - getState
```
public final PlanItemState getState()
```
 Returns:
 
 the state
 - getLastPlanItemTransition
```
public PlanItemTransition getLastPlanItemTransition()
```
 Returns:
 
 the last plan item transition
 - setState
```
public void setState(PlanItemState state)
```
 Parameters:
 
 state - the state
 - getTPlanItemDefinition
```
public TPlanItemDefinition getTPlanItemDefinition()
```
 Returns:
 
 the plan item definition
 - getCasePlanModel
```
public CasePlanModel getCasePlanModel()
```
 Get the casePlanModel from the parent. Climbs up the parent chain to the root (casePlanModel) and returns the root.
 
 Returns:
 
 the case model
 - getClientRef
```
public String getClientRef()
```
 Default implementation returning null.
 
 Returns:
 
 the client reference
 - getClientId
```
public String getClientId()
```
 Returns:
 
 the client id
 - setClientId
```
public void setClientId(String clientId)
```
 Parameters:
 
 clientId - the client id
 - getExtensionType
```
public String getExtensionType()
```
 - getParent
```
public Stage getParent()
```
 - getCustomAttribute
```
public String getCustomAttribute(String name)
```
 - getCustomState
```
public Map<String,String> getCustomState()
```
 Returns:
 
 this plan item’s custom state map. May be null.
 - getCustomState
```
public String getCustomState(String key)
```
 Retrieve a custom state value for the passed key.
 - setCustomState
```
public void setCustomState(String key,
 String value)
```
 Store a value under the given key in the plan item’s custom state map.
 - setCustomState
```
public void setCustomState(String key,
 String value,
 boolean overwrite)
```
 Store a value under the given key in the plan item’s custom state map. The caller may choose not to overwrite an already existing entry for the passed key.
 - applyVisitor
```
public void applyVisitor(PlannableItemVisitor visitor,
 TransitionData transitionData)
```
 Apply a plannable item visitor to this plan item. There are implementations of this method for all plan items which may contain a planning table (currently only stages; human tasks may follow in the future).
 
 Parameters:
 
 visitor - the plannable item visitor.
 
 transitionData - optional evaluation context.
 - getPlanItemTypeShort
```
public String getPlanItemTypeShort()
```
 - toString
```
public String toString()
```
 Overrides:
 
 toString in class Object

Class PlanItem

Method Summary

Methods inherited from class java.lang.Object

Method Detail

handlePlanItemTransition

getNewPlanItemData

getParentInstanceId

getArmedEntrySentries

getDeferredEntrySentries

getArmedExitSentries

getDeferredExitSentries

isArmed

isOfSameHierarchy

isTriggeredExitSentry

isManualActivation

isRepetition

isRequired

isCompletionNeutral

isBlocking

isNonBlockingComplete

isTerminal

isSemiTerminal

isPreActivation

isPending

getAvailableCount

getAvailableCountInStage

getAvailableChildrenCount

getActiveCount

getActiveCountInStage

getActiveChildrenCount

getTriggeredCount

getTriggeredCountInStage

getTriggeredChildrenCount

getCompletedCount

getCompletedCountInStage

getCompletedChildrenCount

getTerminatedCount

getTerminatedCountInStage

getTerminatedChildrenCount

getEnabledCount

getEnabledCountInStage

getEnabledChildrenCount

getDisabledCount

getDisabledCountInStage

getDisabledChildrenCount

getInstanceCount

getInstanceCountInStage

getChildInstanceCount

getIndexInStage

isWaitingOnChildren

isWaitingOnChildren

getId

getInstanceId

getInstanceIntId

createPlanItemAction

isActionHidden

getTriggeredExitSentries

getPlannableItem

getName

getName

getName

getActionName

getActionName

getDescription

getActionDescription

getActivationTime

getState

getLastPlanItemTransition

setState

getTPlanItemDefinition

getCasePlanModel

getClientRef

getClientId

setClientId

getExtensionType

getParent

getCustomAttribute

getCustomState

getCustomState

setCustomState