oracle.bpm.services.instancemanagement.model
Interface IGrabInstanceContext

All Superinterfaces:

java.io.Serializable

public interface IGrabInstanceContext
extends java.io.Serializable

BPMN standard defines compound activities as activities that can contain sub-activities and data objects, allowing to represent a business process as a tree-structure hierarchy of process activities.

An IGrabInstanceContext instance represents a data snapshot of a process instance. In particular, an IGrabInstanceContext instance contains the data state of the BPMN process scope or a BPMN sub-process scope.

This interface defines methods for transversing the tree-structure hierarchy allowing to access to data state of every data context defined by a sub-process activity or a process.

See Also:

IInstanceQueryService, ILocationInfo, IInstanceContextConfiguration

Method Summary

java.lang.Iterable<IOpenActivityInfo>	getAvailableContainerActivities() Gets an Iterable for the available Open/Running activities directly defined in this context.
java.lang.Iterable<ICorrelationKeyItem>	getAvailableCorrelationKeys() Gets an Iterable for the available Correlation Keys declared in this context.
java.lang.Iterable<IVariableItem>	getAvailableInstanceAttributes() Gets an Iterable for the available Process and Activity instance attributes declared in this context.
java.lang.Iterable<IVariableItem>	getAvailableVariables() Gets an Iterable for the available Data Objects declated in this context.
java.lang.Iterable<IGrabInstanceContext>	getChildrenGrabInstanceContext() Gets an Iterable for the available nested contexts.
ILocationInfo	getLocation() Gets the location of this context.
IGrabInstanceContext	getParentGrabInstanceContext() Gets the parent context.

Method Detail

getAvailableVariables

java.lang.Iterable<IVariableItem> getAvailableVariables()

Gets an Iterable for the available Data Objects declated in this context.

Returns:

an iterable of IVariableItem

getAvailableInstanceAttributes

java.lang.Iterable<IVariableItem> getAvailableInstanceAttributes()

Gets an Iterable for the available Process and Activity instance attributes declared in this context.

Returns:

an iterable of IVariableItem

getAvailableCorrelationKeys

java.lang.Iterable<ICorrelationKeyItem> getAvailableCorrelationKeys()

Gets an Iterable for the available Correlation Keys declared in this context.

Returns:

an iterable of ICorrelationKeyItem

getChildrenGrabInstanceContext

java.lang.Iterable<IGrabInstanceContext> getChildrenGrabInstanceContext()

Gets an Iterable for the available nested contexts. Nested contexts are available for Embedded Subporocesses and Call Activities calling a Process.

Returns:

an iterable of IGrabInstanceContext

getLocation

ILocationInfo getLocation()

Gets the location of this context. The location is mainly used to know the runtime instantiation of this context. The context can represent an active Subprocess, an active parallel instance inside a MultiInstance Loop Characteristics, or a running called Process.

Returns:

a ILocationInfo with information about this context location.

getParentGrabInstanceContext

IGrabInstanceContext getParentGrabInstanceContext()

Gets the parent context.

Returns:

the parent IGrabInstanceContext

getAvailableContainerActivities

java.lang.Iterable<IOpenActivityInfo> getAvailableContainerActivities()

Gets an Iterable for the available Open/Running activities directly defined in this context. This method does not return activities running inside children context, like nested subprocesses.

Returns:

an iterable of IOpenActivityInfo