Class ScopeImpl
- java.lang.Object
- 
- org.camunda.bpm.engine.impl.core.model.CoreModelElement
- 
- org.camunda.bpm.engine.impl.core.model.CoreActivity
- 
- org.camunda.bpm.engine.impl.pvm.process.ScopeImpl
 
 
 
- 
- All Implemented Interfaces:
- java.io.Serializable,- PvmProcessElement,- PvmScope
 - Direct Known Subclasses:
- ActivityImpl,- ProcessDefinitionImpl
 
 public abstract class ScopeImpl extends CoreActivity implements PvmScope A Bpmn scope. The scope has references to two lists of activities: - the flow activities (activities for which theflow scopeis this scope - event listener activities (activities for which theevent scopeis this scope.- Author:
- Tom Baeyens, Daniel Meyer
- See Also:
- Serialized Form
 
- 
- 
Nested Class SummaryNested Classes Modifier and Type Class Description static interfaceScopeImpl.BacklogErrorCallbackRepresents the backlog error callback interface.
 - 
Field SummaryFields Modifier and Type Field Description protected java.util.Map<java.lang.String,ScopeImpl.BacklogErrorCallback>BACKLOGThe key identifies the activity which is referenced but not read yet.protected java.util.Set<ActivityImpl>eventActivitiesactivities for which this is the event scopeprotected java.util.List<ActivityImpl>flowActivitiesThe activities for which the flow scope is this scopeprotected booleanisSubProcessScopeprotected java.util.Map<java.lang.String,ActivityImpl>namedFlowActivitiesprotected ProcessDefinitionImplprocessDefinition- 
Fields inherited from class org.camunda.bpm.engine.impl.core.model.CoreActivityioMapping
 - 
Fields inherited from class org.camunda.bpm.engine.impl.core.model.CoreModelElementbuiltInListeners, builtInVariableListeners, id, listeners, name, properties, variableListeners
 
- 
 - 
Constructor SummaryConstructors Constructor Description ScopeImpl(java.lang.String id, ProcessDefinitionImpl processDefinition)
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidaddExecutionListener(java.lang.String eventName, ExecutionListener executionListener)Deprecated.voidaddExecutionListener(java.lang.String eventName, ExecutionListener executionListener, int index)Deprecated.voidaddToBacklog(java.lang.String activityRef, ScopeImpl.BacklogErrorCallback callback)Add's the given activity reference and the error callback to the backlog.booleancontains(ActivityImpl activity)ActivityImplcreateActivity(java.lang.String activityId)ActivityImplfindActivity(java.lang.String activityId)searches for the activity recursivelyActivityImplfindActivityAtLevelOfSubprocess(java.lang.String activityId)Finds an activity at the same level of subprocess.TransitionImplfindTransition(java.lang.String transitionId)Recursively finds a transition.java.util.List<ActivityImpl>getActivities()Returns the flow activities of this scope.java.util.Collection<ScopeImpl.BacklogErrorCallback>getBacklogErrorCallbacks()Returns the backlog error callback's.ActivityImplgetChildActivity(java.lang.String activityId)searches for the activity locallyjava.util.Set<ActivityImpl>getEventActivities()java.util.Map<java.lang.String,java.util.List<ExecutionListener>>getExecutionListeners()Deprecated.java.util.List<ExecutionListener>getExecutionListeners(java.lang.String eventName)Deprecated.ProcessDefinitionImplgetProcessDefinition()The process definition scope, root of the scope hierarchy.booleanisAncestorFlowScopeOf(ScopeImpl other)booleanisBacklogEmpty()Returns true if the backlog is empty.booleanisSubProcessScope()Indicates whether this scope is a sub process scope.voidsetSubProcessScope(boolean isSubProcessScope)- 
Methods inherited from class org.camunda.bpm.engine.impl.core.model.CoreActivitycreateActivity, getActivityBehavior, getIoMapping, setIoMapping, toString
 - 
Methods inherited from class org.camunda.bpm.engine.impl.core.model.CoreModelElementaddBuiltInListener, addBuiltInListener, addBuiltInVariableListener, addBuiltInVariableListener, addListener, addListener, addListenerToMap, addVariableListener, addVariableListener, getBuiltInListeners, getBuiltInListeners, getBuiltInVariableListeners, getBuiltInVariableListenersLocal, getId, getListeners, getListeners, getName, getProperties, getProperty, getVariableListeners, getVariableListenersLocal, setId, setName, setProperties, setProperty
 - 
Methods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 - 
Methods inherited from interface org.camunda.bpm.engine.impl.pvm.PvmProcessElementgetId, getProperties, getProperty
 - 
Methods inherited from interface org.camunda.bpm.engine.impl.pvm.PvmScopegetEventScope, getFlowScope, getLevelOfSubprocessScope, isScope
 
- 
 
- 
- 
- 
Field Detail- 
isSubProcessScopeprotected boolean isSubProcessScope 
 - 
flowActivitiesprotected java.util.List<ActivityImpl> flowActivities The activities for which the flow scope is this scope
 - 
namedFlowActivitiesprotected java.util.Map<java.lang.String,ActivityImpl> namedFlowActivities 
 - 
eventActivitiesprotected java.util.Set<ActivityImpl> eventActivities activities for which this is the event scope
 - 
processDefinitionprotected ProcessDefinitionImpl processDefinition 
 - 
BACKLOGprotected final java.util.Map<java.lang.String,ScopeImpl.BacklogErrorCallback> BACKLOG The key identifies the activity which is referenced but not read yet. The value is the error callback, which is called if the activity is not read till the end of parsing.
 
- 
 - 
Constructor Detail- 
ScopeImplpublic ScopeImpl(java.lang.String id, ProcessDefinitionImpl processDefinition)
 
- 
 - 
Method Detail- 
findActivitypublic ActivityImpl findActivity(java.lang.String activityId) Description copied from class:CoreActivitysearches for the activity recursively- Specified by:
- findActivityin interface- PvmScope
- Overrides:
- findActivityin class- CoreActivity
- Parameters:
- activityId- the id of the activity to find.
- Returns:
- the activity or null
 
 - 
findTransitionpublic TransitionImpl findTransition(java.lang.String transitionId) Description copied from interface:PvmScopeRecursively finds a transition.- Specified by:
- findTransitionin interface- PvmScope
- Parameters:
- transitionId- the transiton to find
- Returns:
- the transition or null
 
 - 
findActivityAtLevelOfSubprocesspublic ActivityImpl findActivityAtLevelOfSubprocess(java.lang.String activityId) Description copied from interface:PvmScopeFinds an activity at the same level of subprocess.- Specified by:
- findActivityAtLevelOfSubprocessin interface- PvmScope
- Parameters:
- activityId- the id of the activity to find.
- Returns:
- the activity or null
 
 - 
getChildActivitypublic ActivityImpl getChildActivity(java.lang.String activityId) searches for the activity locally- Specified by:
- getChildActivityin class- CoreActivity
 
 - 
getBacklogErrorCallbackspublic java.util.Collection<ScopeImpl.BacklogErrorCallback> getBacklogErrorCallbacks() Returns the backlog error callback's.- Returns:
- the callback's
 
 - 
isBacklogEmptypublic boolean isBacklogEmpty() Returns true if the backlog is empty.- Returns:
- true if empty, false otherwise
 
 - 
addToBacklogpublic void addToBacklog(java.lang.String activityRef, ScopeImpl.BacklogErrorCallback callback)Add's the given activity reference and the error callback to the backlog.- Parameters:
- activityRef- the activity reference which is not read until now
- callback- the error callback which should called if activity will not be read
 
 - 
createActivitypublic ActivityImpl createActivity(java.lang.String activityId) - Specified by:
- createActivityin class- CoreActivity
 
 - 
isAncestorFlowScopeOfpublic boolean isAncestorFlowScopeOf(ScopeImpl other) 
 - 
containspublic boolean contains(ActivityImpl activity) 
 - 
getExecutionListeners@Deprecated public java.util.List<ExecutionListener> getExecutionListeners(java.lang.String eventName) Deprecated.
 - 
addExecutionListener@Deprecated public void addExecutionListener(java.lang.String eventName, ExecutionListener executionListener)Deprecated.
 - 
addExecutionListener@Deprecated public void addExecutionListener(java.lang.String eventName, ExecutionListener executionListener, int index)Deprecated.
 - 
getExecutionListeners@Deprecated public java.util.Map<java.lang.String,java.util.List<ExecutionListener>> getExecutionListeners() Deprecated.
 - 
getActivitiespublic java.util.List<ActivityImpl> getActivities() Description copied from interface:PvmScopeReturns the flow activities of this scope. This is the list of activities for which this scope is theflow scope.- Specified by:
- getActivitiesin interface- PvmScope
- Specified by:
- getActivitiesin class- CoreActivity
- Returns:
- the list of flow activities for this scope.
 
 - 
getEventActivitiespublic java.util.Set<ActivityImpl> getEventActivities() 
 - 
isSubProcessScopepublic boolean isSubProcessScope() Description copied from interface:PvmScopeIndicates whether this scope is a sub process scope. A sub process scope is a scope which contains "normal flow".Scopes which are flow scopes but not sub process scopes:- a multi instance body scope
- leaf scope activities which are pure event scopes (Example: User task with attached boundary event)
 - Specified by:
- isSubProcessScopein interface- PvmScope
- Returns:
- true if this is a sub process scope
 
 - 
setSubProcessScopepublic void setSubProcessScope(boolean isSubProcessScope) 
 - 
getProcessDefinitionpublic ProcessDefinitionImpl getProcessDefinition() Description copied from interface:PvmProcessElementThe process definition scope, root of the scope hierarchy.- Specified by:
- getProcessDefinitionin interface- PvmProcessElement
- Returns:
 
 
- 
 
-