oracle.bpm.services.instancemanagement.model
Interface IGrabInstanceContextRequest

All Superinterfaces:

java.io.Serializable

public interface IGrabInstanceContextRequest
extends java.io.Serializable

Defines on object that represents a request to get state data and the available flow changes for a single instance.

Example:

         IProcessInstance processInstance = getProcessInstance(...);
         IInstanceContextConfiguration configuration = ...;
         IGrabInstanceContextRequest request =
             GrabInstanceContextRequest.create(processInstance,
                                               true,
                                               LocationInfo.ROOT_LOCATION,
                                               configuration);
     

The class GrabInstanceContextRequest contains the factory methods to build a grab instance context request.

See Also:

IGrabInstanceContext, GrabInstanceContextRequest

Method Summary

IInstanceContextConfiguration	getInstanceContextConfiguration() Returns the configuration of this request.
ILocationInfo	getLocation() Returns the location of the tree-structure activities hierarchy of the process that is specifying this request.
IProcessInstance	getProcessInstance() Gets the process instance to which the grab context is requested.
java.lang.Boolean	isSuspendInstanceIfRequired() Returns whether the process instance should be suspended before executing this request.

Method Detail

getProcessInstance

IProcessInstance getProcessInstance()

Gets the process instance to which the grab context is requested.

Returns:

the process instance used for the grab context request.

isSuspendInstanceIfRequired

java.lang.Boolean isSuspendInstanceIfRequired()

Returns whether the process instance should be suspended before executing this request.

Returns:

true if the process instance will be suspended, false otherwise

getLocation

ILocationInfo getLocation()

Returns the location of the tree-structure activities hierarchy of the process that is specifying this request.

Returns:

an ILocationInfo pointing to some node (process or activity) of the tree-structure activities hierarchy of the process.

See Also:

LocationInfo, IGrabInstanceContext

getInstanceContextConfiguration

IInstanceContextConfiguration getInstanceContextConfiguration()

Returns the configuration of this request.

Returns:

an IInstanceContextConfiguration instance of this request