oracle.bpm.services.instancemanagement.model
Interface IGrabMultipleInstancesRequest

All Superinterfaces:

IBaseGrabRequest, java.io.Serializable

All Known Subinterfaces:

IMigrateMultipleInstancesRequest

public interface IGrabMultipleInstancesRequest
extends IBaseGrabRequest

The request for Alter Flow over multiple instances.

The following example creates a request to modify all instances, including update of Data Object dataObject1 and Alter Flow two threads running on User Task1 and User Task2 to the corresponding merging gateway in order to join the threads and continue execution:

 IGrabMultipleInstancesRequest request = new GrabMultipleInstancesRequest();
 request.setApplyToAllInstances(true);

 request.setProcessDN(PROCESS_DN);

 final Set flowChangeItemSet = new HashSet();
 final ActivityInfo         target = ActivityInfo.create("PARALLEL_GATEWAY433105473", "Merging Gateway");

 final ActivityInfo         source1 = ActivityInfo.create("ABSTRACT_ACTIVITY433129760", "User Task1"); *
 flowChangeItemSet.add(FlowChangeItem.create(source1, target));

 final ActivityInfo source2 = ActivityInfo.create("ABSTRACT_ACTIVITY433139218", "User Task2");
 flowChangeItemSet.add(FlowChangeItem.create(source2, target));

 request.setRequestedFlowChanges(flowChangeItemSet);

 final Set variableItemSet = new HashSet();
 variableItemSet.add(VariableItem.create("dataObject1", "Modified by me"));

 request.setRequestedVariableValueChanges(variableItemSet);
 

Method Summary

java.lang.String	getProcessDN() Gets the Process DN for the component for this request to execute on.
java.lang.Iterable<IProcessInstance>	getProcessInstances() Gets a collection of process instances to execute the Alter Flow.
boolean	isApplyToAllInstances() Gets whether the request applies to all running instances.
boolean	isResumeInstanceIfRequired() Gets whether the instances have to be resumed.
void	setApplyToAllInstances(boolean applyToAllInstances) Sets whether the request applies to all running instances.
void	setProcessDN(java.lang.String processDN) Sets the Process DN for the component for this request to execute on.
void	setProcessInstances(java.lang.Iterable<IProcessInstance> processInstances) Sets a collection of process instances to execute the Alter Flow.
void	setResumeInstanceIfRequired(boolean resumeInstanceIfRequired) Sets whether the instances have to be resumed.

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

getComments, getRequestedCorrelationKeyValueChanges, getRequestedFlowChanges, getRequestedInstanceAttributeValueChanges, getRequestedVariableValueChanges, getRequester, isValidateValue, setComments, setRequestedCorrelationKeyValueChanges, setRequestedFlowChanges, setRequestedInstanceAttributeValueChanges, setRequestedVariableValueChanges, setRequester, setValidateValue

Method Detail

getProcessDN

java.lang.String getProcessDN()

Gets the Process DN for the component for this request to execute on.

Returns:

the Process DN

setProcessDN

void setProcessDN(java.lang.String processDN)

Sets the Process DN for the component for this request to execute on.

Parameters:

processDN - the Process DN

getProcessInstances

java.lang.Iterable<IProcessInstance> getProcessInstances()

Gets a collection of process instances to execute the Alter Flow. The collection may be null if applying to all instances.

Returns:

an Iterable of the process instances

setProcessInstances

void setProcessInstances(java.lang.Iterable<IProcessInstance> processInstances)

Sets a collection of process instances to execute the Alter Flow. The collection may be null if applying to all instances.

Parameters:

processInstances - an Iterable of the process instances

isResumeInstanceIfRequired

boolean isResumeInstanceIfRequired()

Gets whether the instances have to be resumed.

Returns:

true if the instances have to be resumed, false otherwise

setResumeInstanceIfRequired

void setResumeInstanceIfRequired(boolean resumeInstanceIfRequired)

Sets whether the instances have to be resumed.

Parameters:

resumeInstanceIfRequired - true of the instances have to be resumed, false otherwise

isApplyToAllInstances

boolean isApplyToAllInstances()

Gets whether the request applies to all running instances.

Returns:

true if the request applies to all instances, false otherwise

setApplyToAllInstances

void setApplyToAllInstances(boolean applyToAllInstances)

Sets whether the request applies to all running instances.

Parameters:

applyToAllInstances - true if the request applies to all instances, false otherwise