Skip navigation links

oracle.iam.rm.client
Interface BusinessTransactionOperation

All Superinterfaces:

Operation

public interface BusinessTransactionOperation

extends Operation

Interface for an operation specific to starting a business transaction.

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.iam.rm.client.Operation

Operation.Type

Method Summary

BusinessTransaction	begin(ArgumentSet argumentSet) Begins the business transaction using this operation.
ArgumentSet	getArgumentSet() Gets the set of arguments for this operation.
java.util.Map<java.lang.String,java.lang.Object>	invoke(BusinessTransaction businessTransaction, ArgumentSet argumentSet) Invokes the supplemental operation on the given business transaction.
boolean	isApprovalRequired() Determines whether this operation uses approval.
OperationVerificationResponse	validate(ArgumentSet argumentSet) Validates the operation without invoking it.

Methods inherited from interface oracle.iam.rm.client.Operation

getDefinitionId, getDescription, getOperationId, getTitle, getType

Method Detail

getArgumentSet

ArgumentSet getArgumentSet()

Gets the set of arguments for this operation.

Returns:

ArgumentSet for this operation.

begin

BusinessTransaction begin(ArgumentSet argumentSet)
                          throws ServerException

Begins the business transaction using this operation.

Parameters:

argumentSet - arguments for this operation.

Returns:

Newly created business transaction.

Throws:

ServerException - if an error occurs during the invocation of the business operation.

validate

OperationVerificationResponse validate(ArgumentSet argumentSet)
                                       throws ServerException

Validates the operation without invoking it.

Parameters:

argumentSet - arguments for this operation.

Returns:

an OperationVerificationResponse containing the potential outcome of such an operation.

Throws:

ServerException - if an error occurs during the invocation of the business operation.

invoke

java.util.Map<java.lang.String,java.lang.Object> invoke(BusinessTransaction businessTransaction,
                                                        ArgumentSet argumentSet)
                                                        throws ServerException

Invokes the supplemental operation on the given business transaction.

Parameters:

businessTransaction - the business transaction to be invoked.

argumentSet - arguments for the invocation operation.

Returns:

Map containing any return values of the supplemental operation.

Throws:

ServerException - if an error occurs during the invocation of the supplemental operation.

isApprovalRequired

boolean isApprovalRequired()
                           throws ServerException

Determines whether this operation uses approval. If this returns true, it cannot be used as a supplemental operation.

Returns:

true if the operation uses approval, false otherwise.

Throws:

ServerException

Skip navigation links