oracle.bpm.services.instancemanagement.model
Interface IGrabMultipleInstancesContextRequest

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

IMigrateMultipleInstancesContextRequest

public interface IGrabMultipleInstancesContextRequest
extends java.io.Serializable

A request to get state data for multiple instances.

The following example shows how to create a multiple grab instance context request. In this case, the request specifies to get all the open activities of the root location for each instance.

     Collection processInstances = getProcessInstances(...);
     Collection locations =
        Collections.nCopies(getSelectedProcessInstances().size(),
                            LocationInfo.ROOT_LOCATION);

     InstanceContextConfiguration.Builder builder =
        new InstanceContextConfiguration.Builder();
     builder.includeOpenActivities();
     IInstanceContextConfiguration conf = builder.build();

     IGrabMultipleInstancesContextRequest request =
        GrabMultipleInstancesContextRequest.create(processDn,
                                                   instances,
                                                   true,
                                                   locations,
                                                   conf);
 

Method Summary

IInstanceContextConfiguration	getInstanceContextConfiguration() Returns the specified configuration of this request.
java.lang.Iterable<ILocationInfo>	getLocations() Returns an Iterable containing the target locations of the tree-structure activities hierarchy of the process specified for each process instances in this request.
java.lang.String	getProcessDN() Gets the process DN of the process instances used for this request.
java.lang.Iterable<IProcessInstance>	getProcessInstances() Gets the process instances to which the grab context is requested.
boolean	isSuspendInstancesIfRequired() Returns whether the process instance is suspended when executing the request.

Method Detail

getProcessDN

java.lang.String getProcessDN()

Gets the process DN of the process instances used for this request. The process DN is used to ensure all the process instances in the request belong to the same process.

Returns:

the process DN

getProcessInstances

java.lang.Iterable<IProcessInstance> getProcessInstances()

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

Returns:

an Iterable collection of process instances

isSuspendInstancesIfRequired

boolean isSuspendInstancesIfRequired()

Returns whether the process instance is suspended when executing the request.

Returns:

true if the process instance will be suspended if possible, false otherwise

getLocations

java.lang.Iterable<ILocationInfo> getLocations()

Returns an Iterable containing the target locations of the tree-structure activities hierarchy of the process specified for each process instances in this request.

Returns:

an Iterable collection containing ILocationInfo.

See Also:

LocationInfo, IGrabInstanceContext

getInstanceContextConfiguration

IInstanceContextConfiguration getInstanceContextConfiguration()

Returns the specified configuration of this request.

Returns:

an IInstanceContextConfiguration instance of this request