oracle.bpm.services.instancemanagement.model
Interface IBaseGrabRequest

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

IBaseMigrateInstanceRequest, IGrabInstanceRequest, IGrabMultipleInstancesRequest, IMigrateInstanceRequest, IMigrateMultipleInstancesRequest

public interface IBaseGrabRequest
extends java.io.Serializable

Base interface for a grab request.

Method Summary

java.lang.String	getComments() Gets the comments for the request
java.lang.Iterable<ICorrelationKeyItem>	getRequestedCorrelationKeyValueChanges() Gets the requested Correlation Key changes to apply.
java.lang.Iterable<IFlowChangeItem>	getRequestedFlowChanges() Gets the requested flow changes to apply.
java.lang.Iterable<IVariableItem>	getRequestedInstanceAttributeValueChanges() Gets the requested Instance Attribute changes to apply.
java.lang.Iterable<IVariableItem>	getRequestedVariableValueChanges() Gets the requested Data Object changes to apply.
java.lang.String	getRequester()
boolean	isValidateValue() Returns whether the value will be validated before modifying the Data Object.
void	setComments(java.lang.String comments) Sets the comments for the request
void	setRequestedCorrelationKeyValueChanges(java.lang.Iterable<ICorrelationKeyItem> requestedCorrelationKeyValueChanges) Sets the requested Correlation Key changes to apply.
void	setRequestedFlowChanges(java.lang.Iterable<IFlowChangeItem> requestedFlowChanges) Sets the requested flow changes to apply.
void	setRequestedInstanceAttributeValueChanges(java.lang.Iterable<IVariableItem> requestedInstanceAttributeValueChanges) Sets the requested Instance Attribute changes to apply.
void	setRequestedVariableValueChanges(java.lang.Iterable<IVariableItem> requestedVariableValueChanges) Sets the requested Data Object changes to apply.
void	setRequester(java.lang.String requester)
void	setValidateValue(boolean validateValue) Sets whether the value will be validated before modifying the Data Object.

Method Detail

getRequestedFlowChanges

java.lang.Iterable<IFlowChangeItem> getRequestedFlowChanges()

Gets the requested flow changes to apply.

Returns:

an Iterable of flow changes

setRequestedFlowChanges

void setRequestedFlowChanges(java.lang.Iterable<IFlowChangeItem> requestedFlowChanges)

Sets the requested flow changes to apply.

Parameters:

requestedFlowChanges - an Iterable of flow changes

getRequestedVariableValueChanges

java.lang.Iterable<IVariableItem> getRequestedVariableValueChanges()

Gets the requested Data Object changes to apply.

Returns:

an Iterable of Data Object changes

setRequestedVariableValueChanges

void setRequestedVariableValueChanges(java.lang.Iterable<IVariableItem> requestedVariableValueChanges)

Sets the requested Data Object changes to apply.

Parameters:

requestedVariableValueChanges - an Iterable of Data Object changes

getRequestedInstanceAttributeValueChanges

java.lang.Iterable<IVariableItem> getRequestedInstanceAttributeValueChanges()

Gets the requested Instance Attribute changes to apply.

Returns:

an Iterable of Instance Attribute changes

setRequestedInstanceAttributeValueChanges

void setRequestedInstanceAttributeValueChanges(java.lang.Iterable<IVariableItem> requestedInstanceAttributeValueChanges)

Sets the requested Instance Attribute changes to apply.

Parameters:

requestedInstanceAttributeValueChanges - an Iterable of Instance Attribute changes

getRequestedCorrelationKeyValueChanges

java.lang.Iterable<ICorrelationKeyItem> getRequestedCorrelationKeyValueChanges()

Gets the requested Correlation Key changes to apply.

Returns:

an Iterable of Correlation Key changes

setRequestedCorrelationKeyValueChanges

void setRequestedCorrelationKeyValueChanges(java.lang.Iterable<ICorrelationKeyItem> requestedCorrelationKeyValueChanges)

Sets the requested Correlation Key changes to apply.

Parameters:

requestedCorrelationKeyValueChanges - an Iterable of Correlation Key changes

getComments

java.lang.String getComments()

Gets the comments for the request

Returns:

the request's comments

setComments

void setComments(java.lang.String comments)

Sets the comments for the request

Parameters:

comments - the request's comments

setRequester

void setRequester(java.lang.String requester)

getRequester

java.lang.String getRequester()

isValidateValue

boolean isValidateValue()

Returns whether the value will be validated before modifying the Data Object.

Returns:

true if the value will be validated, false otherwise. Defaults to true.

setValidateValue

void setValidateValue(boolean validateValue)

Sets whether the value will be validated before modifying the Data Object.

Parameters:

validateValue - true if the value will be validated, false otherwise