oracle.bpm.services.instancemanagement.model
Interface IOpenActivityInfo

All Superinterfaces:

IActivityInfo, java.io.Serializable

public interface IOpenActivityInfo
extends IActivityInfo

An IOpenActivityInfo instance represents and bpmn flow element, such as an activity, event or gateway, that contains a process instance token. By definition, a compound activity, such as a sub-process activity, is an open when some of the sub-activities contains a token. An open activity is the source activity of a flow change item because there is a token there that can be grabbed.

Method Summary

java.lang.Iterable<IVariableItem>	getAttributes() Returns the attributes, such as loopCounter, numberOfInstances, numberOfActiveInstances, etc, of this open activity.
ILocationInfo	getLocation() The location of this open activity.
IActivityPathInfo	getPath() Gets the activity path for this open activity.
java.lang.String	getStringPath() Gets the String representation of the path of this open activity.
java.lang.String	getStringPath(java.lang.String pathSeparator, java.lang.Boolean useThreadInstance) Gets the String representation of the path of this open activity.
java.lang.Boolean	isContainerActivity() Returns true if this open activity is a compound activity (sub-process); false otherwise.

Methods inherited from interface oracle.bpm.services.instancemanagement.model.IActivityInfo

getDisplayName, getId, getProcessId

Method Detail

getPath

IActivityPathInfo getPath()

Gets the activity path for this open activity. It represents the path of nested activities that an token has transversed from the process root to reach to its current location.

In spite of the fact that the definition of the interface IActivityPathInfo specifies that path nodes can be formed by activities, event or gateways, in the context of this method, the path is conformed only by compound activity like sub-processes.

Returns:

the IActivityPathInfo of this activity.

getLocation

ILocationInfo getLocation()

The location of this open activity. If the open activity is a sub-process, its location is same to the last element of its path. On the other hand, when the open activity is a non-compound activity, gateway or an event, the last element of its path represents the container node element of this open activity.

Returns:

the ILocationInfo of this activity.

isContainerActivity

java.lang.Boolean isContainerActivity()

Returns true if this open activity is a compound activity (sub-process); false otherwise.

Returns:

true if this open activity is a compound activity (sub-process); false otherwise.

getAttributes

java.lang.Iterable<IVariableItem> getAttributes()

Returns the attributes, such as loopCounter, numberOfInstances, numberOfActiveInstances, etc, of this open activity.

Returns:

a Iterable of IVariableItem representing the activities attributes of this open activity.

getStringPath

java.lang.String getStringPath()

Gets the String representation of the path of this open activity. Each node of the path is represented by its activity label. This method uses the string " -> " as path separator and shows the loop counter for multi-instance activities.

Returns:

the String representation of the path of this open activity.

See Also:

getStringPath(String, Boolean)

getStringPath

java.lang.String getStringPath(java.lang.String pathSeparator,
                               java.lang.Boolean useThreadInstance)

Gets the String representation of the path of this open activity. Each node of the path is represented by its activity label.

Parameters:

pathSeparator - the string to be used as a separator of path nodes.

useThreadInstance - true to use the thread number for multi instance sub-process. Otherwise, it will use the loop counter for multi-instance activities.

Returns:

the String representation of the path of this open activity.