Skip navigation links

oracle.iam.rm.client
Interface BusinessTransaction

All Superinterfaces:

Interactable

public interface BusinessTransaction

extends Interactable

A handle interface that can be used to inspect and operate on running business transactions.

Method Summary

void	cancel() Cancels the business transaction.
boolean	forward() Forwards or finishes this business transaction.
ConstraintViolation[]	getConstraintViolations() Gets any outstanding constraint violations from a business transaction.
Operation	getOperation(java.lang.String operationId) Gets an operation by identifier.
java.util.Map<java.lang.String,java.lang.Object>	getReturnArguments() Returns any outputs produced as past of the invocation of the operation.
long	getTransactionId() Gets the transaction ID as a long.
boolean	quickValidate() Runs lightweight validation tests.

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

getOperation, getOperations

Method Detail

getTransactionId

long getTransactionId()

Gets the transaction ID as a long.

Returns:

long representing the transaction ID.

forward

boolean forward()
                throws ServerException

Forwards or finishes this business transaction.

Returns:

Boolean true if the business transaction has finished after this method returns, otherwise false.

Throws:

ServerException - if a failure occurs during the forwarding process.

cancel

void cancel()
            throws ServerException

Cancels the business transaction.

Throws:

ServerException - if a failure occurs during the cancellation process.

getConstraintViolations

ConstraintViolation[] getConstraintViolations()
                                              throws ServerException

Gets any outstanding constraint violations from a business transaction. As this data may be calculated asynchronously, it may be out of date at any point in time.

Returns:

ConstraintViolation array of ConstraintViolations or an empty array if there no violations.

Throws:

ServerException - if a failure occurs retrieving the constraint violations.

getReturnArguments

java.util.Map<java.lang.String,java.lang.Object> getReturnArguments()

Returns any outputs produced as past of the invocation of the operation. This will be empty except when returned after the incocation of an operation.

Returns:

any outputs produced as past of the invocation of the operation.

getOperation

Operation getOperation(java.lang.String operationId)
                       throws ServerException

Gets an operation by identifier.

Parameters:

operationId - the business operation

Returns:

Operation identified by the passed String.

Throws:

ServerException - if an error occurs during operation retrieval.

quickValidate

boolean quickValidate()
                      throws ServerException

Runs lightweight validation tests. This should be used before forwarding the business transaction in order to minimize the possibility of the finalization processes failing when the user could have resolved the issue. <p/> If the validation fails, the issues should be available via the getConstraintViolations() method.

Returns:

true if the validation succeeds, false otherwise.

Throws:

ServerException - if an error occurs during validation.

Skip navigation links