PlanItemView (edoras one Java API (2.0.7))

All Superinterfaces:

ElementView

All Known Implementing Classes:

DefaultPlanItemView, OnePlanItemView
```
public interface PlanItemView
extends ElementView
```
Exposes a view to a plan item instance (i.e. wraps the respective underlying object and exposes a simplified public API for the object). Can be used for expression resolution (e.g. to expose plan items EL expressions without wanting to expose all public properties of the object).

Method Summary

All Methods Instance Methods Abstract 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()`
`PlanItemView`	`getCasePlanModel()`
`int`	`getChildInstanceCount()`
`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()`
`int`	`getIndex()` Synonym for `ElementView.getInstanceIntId()`.
`int`	`getIndexInStage()`
`int`	`getInstanceCount()`
`int`	`getInstanceCountInStage()`
`String`	`getName()`
`PlanItemView`	`getParent()`
`String`	`getParentClientId()`
`int`	`getTerminatedChildrenCount()`
`int`	`getTerminatedCount()`
`int`	`getTerminatedCountInStage()`
`int`	`getTriggeredChildrenCount()`
`int`	`getTriggeredCount()`
`int`	`getTriggeredCountInStage()`
`boolean`	`isArmed()`
`boolean`	`isAutoComplete()`
`boolean`	`isBlocking()`
`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 interface com.edorasware.cmmn.model.expressions.ElementView
getCaseFileItemInternal, getClientId, getId, getInstanceId, getInstanceIntId, getLastTransition, getPlanItemInternal, getState, isCaseFileItem

- Method Detail
  - getIndex
```
int getIndex()
```
    Synonym for ElementView.getInstanceIntId().
  - getIndexInStage
```
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.
  - getInstanceCountInStage
```
int getInstanceCountInStage()
```
    Returns:
    
    the number of instances of this plan item type within its parent stage instance.
  - getAvailableCount
```
int getAvailableCount()
```
    Returns:
    
    the number of instances of this plan item type that are available.
  - getAvailableCountInStage
```
int getAvailableCountInStage()
```
    Returns:
    
    the number of instances of this plan item type that are available within its parent stage instance.
  - getActiveCount
```
int getActiveCount()
```
    Returns:
    
    the number of instances of this plan item type that are active.
  - getActiveCountInStage
```
int getActiveCountInStage()
```
    Returns:
    
    the number of instances of this plan item type that are active within its parent stage instance.
  - getTriggeredCount
```
int getTriggeredCount()
```
    Returns:
    
    the number of instances of this plan item type that have been triggered.
  - getTriggeredCountInStage
```
int getTriggeredCountInStage()
```
    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
```
int getCompletedCount()
```
    Returns:
    
    the number of instances of this plan item type that are have been completed.
  - getCompletedCountInStage
```
int getCompletedCountInStage()
```
    Returns:
    
    the number of instances of this plan item type that are active within its parent stage instance.
  - getTerminatedCount
```
int getTerminatedCount()
```
    Returns:
    
    the number of instances of this plan item type that have been terminated.
  - getTerminatedCountInStage
```
int getTerminatedCountInStage()
```
    Returns:
    
    the number of instances of this plan item type that have been terminated within its parent stage instance.
  - getEnabledCount
```
int getEnabledCount()
```
    Returns:
    
    the number of instances of this plan item type that have been enabled.
  - getEnabledCountInStage
```
int getEnabledCountInStage()
```
    Returns:
    
    the number of instances of this plan item type that are enabled within its parent stage instance.
  - getDisabledCount
```
int getDisabledCount()
```
    Returns:
    
    the number of instances of this plan item type that have been disabled.
  - getDisabledCountInStage
```
int getDisabledCountInStage()
```
    Returns:
    
    the number of instances of this plan item type that are disabled within its parent stage instance.
  - getInstanceCount
```
int getInstanceCount()
```
    Returns:
    
    the number of instances of this plan item type.
  - getName
```
String getName()
```
    Returns:
    
    The name of the plan item.
  - isRequired
```
boolean isRequired()
```
    Returns:
    
    the current state of the Required rule of this plan item.
  - isRepetition
```
boolean isRepetition()
```
    Returns:
    
    the current state of the Repetition rule of this plan item.
  - isManualActivation
```
boolean isManualActivation()
```
    Returns:
    
    the current state of the Manual Activation rule of this plan item.
  - isCompletionNeutral
```
boolean isCompletionNeutral()
```
    Returns:
    
    the state of the Completion Neutral property of this plan item.
  - isAutoComplete
```
boolean isAutoComplete()
```
    Returns:
    
    the state of the AutoComplete property of this (stage) plan item.
  - isBlocking
```
boolean isBlocking()
```
    Returns:
    
    the state of the Blocking property of this plan item.
  - isTerminal
```
boolean isTerminal()
```
    Returns:
    
    true if and only if this plan item is in terminal state.
  - isSemiTerminal
```
boolean isSemiTerminal()
```
    Returns:
    
    true if and only if this plan item is in semi-terminal state.
  - isPreActivation
```
boolean isPreActivation()
```
    Returns:
    
    true if and only if this plan item is in any state before PlanItemState.ACTIVE.
  - getParent
```
PlanItemView getParent()
```
    Returns:
    
    a plan item view to the parent of this element (if any). May return null if not applicable.
  - getCasePlanModel
```
PlanItemView getCasePlanModel()
```
    Returns:
    
    a plan item view to the parent of this element (if any). May return null if not applicable.
  - getParentClientId
```
String getParentClientId()
```
    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.
  - getArmedEntrySentries
```
Set<String> getArmedEntrySentries()
```
    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
```
Set<String> getDeferredEntrySentries()
```
    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
```
Set<String> getArmedExitSentries()
```
    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
```
Set<String> getDeferredExitSentries()
```
    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
```
boolean isArmed()
```
    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 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
```
Map<String,String> getCustomState()
```
    The plan item’s custom run-time state. The map is managed by modelers and extension implementers. May be null.
  - getAvailableChildrenCount
```
int getAvailableChildrenCount()
```
    Returns:
    
    the number of instances of available plan items in this stage. Return 0 when called on a non stage plan item.
  - getActiveChildrenCount
```
int getActiveChildrenCount()
```
    Returns:
    
    the number of instances of active plan items in this stage. Return 0 when called on a non stage plan item.
  - getChildInstanceCount
```
int getChildInstanceCount()
```
    Returns:
    
    the number of plan item instances in this stage. Return 0 when called on a non stage plan item.
  - getCompletedChildrenCount
```
int getCompletedChildrenCount()
```
    Returns:
    
    the number of instances of completed plan items in this stage. Return 0 when called on a non stage plan item.
  - getDisabledChildrenCount
```
int getDisabledChildrenCount()
```
    Returns:
    
    the number of instances of disabled plan items in this stage. Return 0 when called on a non stage plan item.
  - getEnabledChildrenCount
```
int getEnabledChildrenCount()
```
    Returns:
    
    the number of instances of enabled plan items in this stage. Return 0 when called on a non stage plan item.
  - getTerminatedChildrenCount
```
int getTerminatedChildrenCount()
```
    Returns:
    
    the number of instances of terminated plan items in this stage. Return 0 when called on a non stage plan item.
  - getTriggeredChildrenCount
```
int getTriggeredChildrenCount()
```
    Returns:
    
    the number of instances of triggered plan items in this stage. Return 0 when called on a non stage plan item.
  - isWaitingOnChildren
```
boolean isWaitingOnChildren()
```
    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
```
boolean waitingOnChildren(boolean stageAutoComplete)
```
    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.
  - isCaseTask
```
boolean isCaseTask()
```
    Returns:
    
    true when called on a plan item of a case plan model that represents a case task. Returns false otherwise.
  - isSubCaseTask
```
boolean isSubCaseTask()
```
    Returns:
    
    true if the current case plan model was created from a case task and is of type sub-case. Returns false otherwise.
  - isRootCaseTask
```
boolean isRootCaseTask()
```
    Returns:
    
    true if the current case plan model was created from a case task and is of type root case. Returns false otherwise.

Interface PlanItemView

Method Summary

Methods inherited from interface com.edorasware.cmmn.model.expressions.ElementView

Method Detail

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

getParent

getCasePlanModel

getParentClientId

getArmedEntrySentries

getDeferredEntrySentries

getArmedExitSentries

getDeferredExitSentries

isArmed

getCustomState

getAvailableChildrenCount

getActiveChildrenCount

getChildInstanceCount

getCompletedChildrenCount

getDisabledChildrenCount

getEnabledChildrenCount

getTerminatedChildrenCount

getTriggeredChildrenCount

isWaitingOnChildren

waitingOnChildren

isCaseTask

isSubCaseTask

isRootCaseTask