DefaultPlanItemView (edoras one Java API (2.0.8))

java.lang.Object
- com.edorasware.cmmn.model.expressions.DefaultPlanItemView

All Implemented Interfaces:

CaseTaskView, ElementView, PlanItemView

Direct Known Subclasses:

OnePlanItemView
```
public class DefaultPlanItemView
extends Object
implements PlanItemView, CaseTaskView
```

Constructor Summary

Constructors
Constructor and Description
`DefaultPlanItemView(PlanItem planItemInternal, TransitionData transitionData, ViewCreators viewCreators, EvaluationListeners evaluationListeners, PersistenceListeners persistenceListeners, SynchronizedLowLevelCmmnService synchronizedLowLevelCmmnService)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getActiveChildrenCount()`
`int`	`getActiveCount()`
`int`	`getActiveCountInStage()`
`Set<String>`	`getArmedEntrySentries()`
`Set<String>`	`getArmedExitSentries()`
`int`	`getAvailableChildrenCount()`
`int`	`getAvailableCount()`
`int`	`getAvailableCountInStage()`
`CaseFileItemInstance`	`getCaseFileItemInternal()`
`PlanItemView`	`getCasePlanModel()`
`int`	`getChildInstanceCount()`
`String`	`getClientId()`
`int`	`getCompletedChildrenCount()`
`int`	`getCompletedCount()`
`int`	`getCompletedCountInStage()`
`Map<String,String>`	`getCustomState()` The plan item’s custom run-time state.
`Set<String>`	`getDeferredEntrySentries()`
`Set<String>`	`getDeferredExitSentries()`
`int`	`getDisabledChildrenCount()`
`int`	`getDisabledCount()`
`int`	`getDisabledCountInStage()`
`int`	`getEnabledChildrenCount()`
`int`	`getEnabledCount()`
`int`	`getEnabledCountInStage()`
`String`	`getId()`
`int`	`getIndex()` Synonym for `ElementView.getInstanceIntId()`.
`int`	`getIndexInStage()`
`int`	`getInstanceCount()`
`int`	`getInstanceCountInStage()`
`String`	`getInstanceId()`
`int`	`getInstanceIntId()`
`String`	`getLastTransition()`
`String`	`getName()`
`PlanItemView`	`getOwnerCasePlanModel()` Applies to plan items of a case plan model that has been created as a result of a case task.
`PlanItemView`	`getParent()`
`PlanItemView`	`getParentCasePlanModel()` Applies to plan items of a case plan model that has been created as a result of a case task.
`String`	`getParentClientId()`
`PlanItem`	`getPlanItemInternal()`
`Map<String,PlanItemView>`	`getPlanItems()` Applies to plan items of type CaseTask.
`String`	`getState()`
`PlanItemView`	`getTargetCasePlanModel()` Applies to plan items of type CaseTask.
`int`	`getTerminatedChildrenCount()`
`int`	`getTerminatedCount()`
`int`	`getTerminatedCountInStage()`
`PlanItemView`	`getTopMostCasePlanModel()` Applies to plan items of a case plan model that has been created as a result of a case task.
`int`	`getTriggeredChildrenCount()`
`int`	`getTriggeredCount()`
`int`	`getTriggeredCountInStage()`
`boolean`	`isArmed()`
`boolean`	`isAutoComplete()`
`boolean`	`isBlocking()`
`boolean`	`isCaseFileItem()`
`boolean`	`isCaseTask()`
`boolean`	`isCompletionNeutral()`
`boolean`	`isManualActivation()`
`boolean`	`isPreActivation()`
`boolean`	`isRepetition()`
`boolean`	`isRequired()`
`boolean`	`isRootCaseTask()`
`boolean`	`isSemiTerminal()`
`boolean`	`isSubCaseTask()`
`boolean`	`isTerminal()`
`boolean`	`isWaitingOnChildren()`
`boolean`	`waitingOnChildren(boolean stageAutoComplete)`

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

- Constructor Detail
  - DefaultPlanItemView
```
public DefaultPlanItemView(PlanItem planItemInternal,
                           TransitionData transitionData,
                           ViewCreators viewCreators,
                           EvaluationListeners evaluationListeners,
                           PersistenceListeners persistenceListeners,
                           SynchronizedLowLevelCmmnService synchronizedLowLevelCmmnService)
```
- Method Detail
  - getId
```
public String getId()
```
    Specified by:
    
    getId in interface ElementView
    
    Returns:
    
    the element’s model Id.
  - getInstanceId
```
public String getInstanceId()
```
    Specified by:
    
    getInstanceId in interface ElementView
    
    Returns:
    
    the element’s instance Id.
  - getInstanceIntId
```
public int getInstanceIntId()
```
    Specified by:
    
    getInstanceIntId in interface ElementView
    
    Returns:
    
    the element’s instance Id’s suffix value.
  - getClientId
```
public String getClientId()
```
    Specified by:
    
    getClientId in interface ElementView
    
    Returns:
    
    the element’s client Id.
  - getState
```
public String getState()
```
    Specified by:
    
    getState in interface ElementView
    
    Returns:
    
    the plan item or case file item state as a string.
  - getLastTransition
```
public String getLastTransition()
```
    Specified by:
    
    getLastTransition in interface ElementView
    
    Returns:
    
    the plan item’s or case file item’s last transition as a string.
  - isCaseFileItem
```
public boolean isCaseFileItem()
```
    Specified by:
    
    isCaseFileItem in interface ElementView
    
    Returns:
    
    true if and only if this element represents a case file item.
  - getCaseFileItemInternal
```
public CaseFileItemInstance getCaseFileItemInternal()
```
    Specified by:
    
    getCaseFileItemInternal in interface ElementView
    
    Returns:
    
    the internal case file item instance represented by this element view if it in fact represents a case file item. Returns null when called on an element of type plan item.
  - getPlanItemInternal
```
public PlanItem getPlanItemInternal()
```
    Specified by:
    
    getPlanItemInternal in interface ElementView
    
    Returns:
    
    the internal plan item instance represented by this element view if it in fact represents a plan item. Returns null when called on an element of type case file item.
  - getParent
```
public PlanItemView getParent()
```
    Specified by:
    
    getParent in interface PlanItemView
    
    Returns:
    
    a plan item view to the parent of this element (if any). May return null if not applicable.
  - getCasePlanModel
```
public PlanItemView getCasePlanModel()
```
    Specified by:
    
    getCasePlanModel in interface PlanItemView
    
    Returns:
    
    a plan item view to the parent of this element (if any). May return null if not applicable.
  - getParentClientId
```
public String getParentClientId()
```
    Specified by:
    
    getParentClientId in interface PlanItemView
    
    Returns:
    
    the client Id of the parent case. This only applies to plan items of case plan models that represent case tasks. When called on a top-level case (no case task case), this method returnd null.
  - isCaseTask
```
public boolean isCaseTask()
```
    Specified by:
    
    isCaseTask in interface PlanItemView
    
    Returns:
    
    true when called on a plan item of a case plan model that represents a case task. Returns false otherwise.
  - isRootCaseTask
```
public boolean isRootCaseTask()
```
    Specified by:
    
    isRootCaseTask in interface PlanItemView
    
    Returns:
    
    true if the current case plan model was created from a case task and is of type root case. Returns false otherwise.
  - isSubCaseTask
```
public boolean isSubCaseTask()
```
    Specified by:
    
    isSubCaseTask in interface PlanItemView
    
    Returns:
    
    true if the current case plan model was created from a case task and is of type sub-case. Returns false otherwise.
  - getIndex
```
public int getIndex()
```
    Description copied from interface: PlanItemView
    
    Synonym for ElementView.getInstanceIntId().
    
    Specified by:
    
    getIndex in interface PlanItemView
  - getIndexInStage
```
public int getIndexInStage()
```
    Specified by:
    
    getIndexInStage in interface PlanItemView
    
    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.
  - getInstanceCountInStage
```
public int getInstanceCountInStage()
```
    Specified by:
    
    getInstanceCountInStage in interface PlanItemView
    
    Returns:
    
    the number of instances of this plan item type within its parent stage instance.
  - getAvailableCount
```
public int getAvailableCount()
```
    Specified by:
    
    getAvailableCount in interface PlanItemView
    
    Returns:
    
    the number of instances of this plan item type that are available.
  - getAvailableCountInStage
```
public int getAvailableCountInStage()
```
    Specified by:
    
    getAvailableCountInStage in interface PlanItemView
    
    Returns:
    
    the number of instances of this plan item type that are available within its parent stage instance.
  - getActiveCount
```
public int getActiveCount()
```
    Specified by:
    
    getActiveCount in interface PlanItemView
    
    Returns:
    
    the number of instances of this plan item type that are active.
  - getActiveCountInStage
```
public int getActiveCountInStage()
```
    Specified by:
    
    getActiveCountInStage in interface PlanItemView
    
    Returns:
    
    the number of instances of this plan item type that are active within its parent stage instance.
  - getTriggeredCount
```
public int getTriggeredCount()
```
    Specified by:
    
    getTriggeredCount in interface PlanItemView
    
    Returns:
    
    the number of instances of this plan item type that have been triggered.
  - getTriggeredCountInStage
```
public int getTriggeredCountInStage()
```
    Specified by:
    
    getTriggeredCountInStage in interface PlanItemView
    
    Returns:
    
    the number of instances of this plan item type that have been triggered (START, MANUAL_START or OCCUR) within its parent stage instance.
  - getCompletedCount
```
public int getCompletedCount()
```
    Specified by:
    
    getCompletedCount in interface PlanItemView
    
    Returns:
    
    the number of instances of this plan item type that are have been completed.
  - getCompletedCountInStage
```
public int getCompletedCountInStage()
```
    Specified by:
    
    getCompletedCountInStage in interface PlanItemView
    
    Returns:
    
    the number of instances of this plan item type that are active within its parent stage instance.
  - getTerminatedCount
```
public int getTerminatedCount()
```
    Specified by:
    
    getTerminatedCount in interface PlanItemView
    
    Returns:
    
    the number of instances of this plan item type that have been terminated.
  - getTerminatedCountInStage
```
public int getTerminatedCountInStage()
```
    Specified by:
    
    getTerminatedCountInStage in interface PlanItemView
    
    Returns:
    
    the number of instances of this plan item type that have been terminated within its parent stage instance.
  - getEnabledCount
```
public int getEnabledCount()
```
    Specified by:
    
    getEnabledCount in interface PlanItemView
    
    Returns:
    
    the number of instances of this plan item type that have been enabled.
  - getEnabledCountInStage
```
public int getEnabledCountInStage()
```
    Specified by:
    
    getEnabledCountInStage in interface PlanItemView
    
    Returns:
    
    the number of instances of this plan item type that are enabled within its parent stage instance.
  - getDisabledCount
```
public int getDisabledCount()
```
    Specified by:
    
    getDisabledCount in interface PlanItemView
    
    Returns:
    
    the number of instances of this plan item type that have been disabled.
  - getDisabledCountInStage
```
public int getDisabledCountInStage()
```
    Specified by:
    
    getDisabledCountInStage in interface PlanItemView
    
    Returns:
    
    the number of instances of this plan item type that are disabled within its parent stage instance.
  - getInstanceCount
```
public int getInstanceCount()
```
    Specified by:
    
    getInstanceCount in interface PlanItemView
    
    Returns:
    
    the number of instances of this plan item type.
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface PlanItemView
    
    Returns:
    
    The name of the plan item.
  - isRequired
```
public boolean isRequired()
```
    Specified by:
    
    isRequired in interface PlanItemView
    
    Returns:
    
    the current state of the Required rule of this plan item.
  - isRepetition
```
public boolean isRepetition()
```
    Specified by:
    
    isRepetition in interface PlanItemView
    
    Returns:
    
    the current state of the Repetition rule of this plan item.
  - isManualActivation
```
public boolean isManualActivation()
```
    Specified by:
    
    isManualActivation in interface PlanItemView
    
    Returns:
    
    the current state of the Manual Activation rule of this plan item.
  - isCompletionNeutral
```
public boolean isCompletionNeutral()
```
    Specified by:
    
    isCompletionNeutral in interface PlanItemView
    
    Returns:
    
    the state of the Completion Neutral property of this plan item.
  - isAutoComplete
```
public boolean isAutoComplete()
```
    Specified by:
    
    isAutoComplete in interface PlanItemView
    
    Returns:
    
    the state of the AutoComplete property of this (stage) plan item.
  - isBlocking
```
public boolean isBlocking()
```
    Specified by:
    
    isBlocking in interface PlanItemView
    
    Returns:
    
    the state of the Blocking property of this plan item.
  - isTerminal
```
public boolean isTerminal()
```
    Specified by:
    
    isTerminal in interface PlanItemView
    
    Returns:
    
    true if and only if this plan item is in terminal state.
  - isSemiTerminal
```
public boolean isSemiTerminal()
```
    Specified by:
    
    isSemiTerminal in interface PlanItemView
    
    Returns:
    
    true if and only if this plan item is in semi-terminal state.
  - isPreActivation
```
public boolean isPreActivation()
```
    Specified by:
    
    isPreActivation in interface PlanItemView
    
    Returns:
    
    true if and only if this plan item is in any state before PlanItemState.ACTIVE.
  - getArmedEntrySentries
```
public Set<String> getArmedEntrySentries()
```
    Specified by:
    
    getArmedEntrySentries in interface PlanItemView
    
    Returns:
    
    the set of entry sentries (model IDs) whose condition is either missing or true. Returns an empty set for a plan item that has already been fired.
  - getDeferredEntrySentries
```
public Set<String> getDeferredEntrySentries()
```
    Specified by:
    
    getDeferredEntrySentries in interface PlanItemView
    
    Returns:
    
    the set of entry sentries (model IDs) whose on-parts have triggered. Returns an empty set for a plan item that has already been fired. Never includes sentries with trigger mode 'On event'.
  - getArmedExitSentries
```
public Set<String> getArmedExitSentries()
```
    Specified by:
    
    getArmedExitSentries in interface PlanItemView
    
    Returns:
    
    the set of exit sentries (model IDs) whose condition is either missing or true. Returns an empty set for a plan item that has not yet been created or is terminal.
  - getDeferredExitSentries
```
public Set<String> getDeferredExitSentries()
```
    Specified by:
    
    getDeferredExitSentries in interface PlanItemView
    
    Returns:
    
    the set of exit sentries (model IDs) whose on-parts have triggered. Returns an empty set for a plan item that has not yet been created or is terminal. Never includes sentries with trigger mode 'On event'.
  - isArmed
```
public boolean isArmed()
```
    Specified by:
    
    isArmed in interface PlanItemView
    
    Returns:
    
    true if the underlying 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 PlanItemView.getArmedEntrySentries()). 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.
  - getCustomState
```
public Map<String,String> getCustomState()
```
    Description copied from interface: PlanItemView
    
    The plan item’s custom run-time state. The map is managed by modelers and extension implementers. May be null.
    
    Specified by:
    
    getCustomState in interface PlanItemView
  - getAvailableChildrenCount
```
public int getAvailableChildrenCount()
```
    Specified by:
    
    getAvailableChildrenCount in interface PlanItemView
    
    Returns:
    
    the number of instances of available plan items in this stage. Return 0 when called on a non stage plan item.
  - getActiveChildrenCount
```
public int getActiveChildrenCount()
```
    Specified by:
    
    getActiveChildrenCount in interface PlanItemView
    
    Returns:
    
    the number of instances of active plan items in this stage. Return 0 when called on a non stage plan item.
  - getChildInstanceCount
```
public int getChildInstanceCount()
```
    Specified by:
    
    getChildInstanceCount in interface PlanItemView
    
    Returns:
    
    the number of plan item instances in this stage. Return 0 when called on a non stage plan item.
  - getCompletedChildrenCount
```
public int getCompletedChildrenCount()
```
    Specified by:
    
    getCompletedChildrenCount in interface PlanItemView
    
    Returns:
    
    the number of instances of completed plan items in this stage. Return 0 when called on a non stage plan item.
  - getDisabledChildrenCount
```
public int getDisabledChildrenCount()
```
    Specified by:
    
    getDisabledChildrenCount in interface PlanItemView
    
    Returns:
    
    the number of instances of disabled plan items in this stage. Return 0 when called on a non stage plan item.
  - getEnabledChildrenCount
```
public int getEnabledChildrenCount()
```
    Specified by:
    
    getEnabledChildrenCount in interface PlanItemView
    
    Returns:
    
    the number of instances of enabled plan items in this stage. Return 0 when called on a non stage plan item.
  - getTerminatedChildrenCount
```
public int getTerminatedChildrenCount()
```
    Specified by:
    
    getTerminatedChildrenCount in interface PlanItemView
    
    Returns:
    
    the number of instances of terminated plan items in this stage. Return 0 when called on a non stage plan item.
  - getTriggeredChildrenCount
```
public int getTriggeredChildrenCount()
```
    Specified by:
    
    getTriggeredChildrenCount in interface PlanItemView
    
    Returns:
    
    the number of instances of triggered plan items in this stage. Return 0 when called on a non stage plan item.
  - isWaitingOnChildren
```
public boolean isWaitingOnChildren()
```
    Specified by:
    
    isWaitingOnChildren in interface PlanItemView
    
    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.
  - waitingOnChildren
```
public boolean waitingOnChildren(boolean stageAutoComplete)
```
    Specified by:
    
    waitingOnChildren in interface PlanItemView
    
    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.
  - getOwnerCasePlanModel
```
public PlanItemView getOwnerCasePlanModel()
```
    Description copied from interface: CaseTaskView
    
    Applies to plan items of a case plan model that has been created as a result of a case task.
    
    Specified by:
    
    getOwnerCasePlanModel in interface CaseTaskView
    
    Returns:
    
    the case plan model of the case that started this case task. Applies to all types of case tasks (root or sub-case). Returns null for top level Cases (i.e. cases not started from a Case task).
  - getParentCasePlanModel
```
public PlanItemView getParentCasePlanModel()
```
    Description copied from interface: CaseTaskView
    
    Applies to plan items of a case plan model that has been created as a result of a case task.
    
    Specified by:
    
    getParentCasePlanModel in interface CaseTaskView
    
    Returns:
    
    the case plan model of the parent case. Only applies to case tasks of type sub-case. Returns null for any other type of case.
  - getTopMostCasePlanModel
```
public PlanItemView getTopMostCasePlanModel()
```
    Description copied from interface: CaseTaskView
    
    Applies to plan items of a case plan model that has been created as a result of a case task.
    
    Specified by:
    
    getTopMostCasePlanModel in interface CaseTaskView
    
    Returns:
    
    the case plan model of the top most CMMN case in the current case hierarchy. When called for a root case task or a top-level case, will return its own case plan model.
  - getPlanItems
```
public Map<String,PlanItemView> getPlanItems()
```
    Description copied from interface: CaseTaskView
    
    Applies to plan items of type CaseTask.
    
    Specified by:
    
    getPlanItems in interface CaseTaskView
    
    Returns:
    
    the case task’s plan items. Returns null for case tasks that have not yet been started or for plan items that are not of type case task.
  - getTargetCasePlanModel
```
public PlanItemView getTargetCasePlanModel()
```
    Description copied from interface: CaseTaskView
    
    Applies to plan items of type CaseTask.
    
    Specified by:
    
    getTargetCasePlanModel in interface CaseTaskView
    
    Returns:
    
    the case plan model of the case started by the case task. Returns null for case tasks that have not yet been started.

Class DefaultPlanItemView

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultPlanItemView

Method Detail

getId

getInstanceId

getInstanceIntId

getClientId

getState

getLastTransition

isCaseFileItem

getCaseFileItemInternal

getPlanItemInternal

getParent

getCasePlanModel

getParentClientId

isCaseTask

isRootCaseTask

isSubCaseTask

getIndex

getIndexInStage

getInstanceCountInStage

getAvailableCount

getAvailableCountInStage

getActiveCount

getActiveCountInStage

getTriggeredCount

getTriggeredCountInStage

getCompletedCount

getCompletedCountInStage

getTerminatedCount

getTerminatedCountInStage

getEnabledCount

getEnabledCountInStage

getDisabledCount

getDisabledCountInStage

getInstanceCount

getName

isRequired

isRepetition

isManualActivation

isCompletionNeutral

isAutoComplete

isBlocking

isTerminal

isSemiTerminal

isPreActivation

getArmedEntrySentries

getDeferredEntrySentries

getArmedExitSentries

getDeferredExitSentries

isArmed

getCustomState

getAvailableChildrenCount

getActiveChildrenCount

getChildInstanceCount

getCompletedChildrenCount

getDisabledChildrenCount

getEnabledChildrenCount

getTerminatedChildrenCount

getTriggeredChildrenCount

isWaitingOnChildren

waitingOnChildren

getOwnerCasePlanModel

getParentCasePlanModel

getTopMostCasePlanModel

getPlanItems

getTargetCasePlanModel