oracle.adf.share.sandbox

Class SandboxTransaction

java.lang.Object

oracle.adf.share.sandbox.ChangeSet

oracle.adf.share.sandbox.UndoableChanges

oracle.adf.share.sandbox.SandboxTransaction

All Implemented Interfaces:

java.lang.Iterable<ObjectDiffs>

public abstract class SandboxTransaction
extends UndoableChanges

Changes as a result of a sandbox operation which can be suspended, resumed, cancelled or completed.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SandboxTransaction.State The state of a SandboxTransaction.

Field Summary

Fields inherited from class oracle.adf.share.sandbox.ChangeSet

EMPTY_CHANGE_SET

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SandboxTransaction(Sandbox sandbox, java.lang.String reposId) Creates a sandbox transaction with UUID.randomUUID() as the transaction ID.
protected	SandboxTransaction(Sandbox sandbox, java.lang.String reposId, java.lang.String transId) Creates a sandbox transaction.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getId() Returns the ID of this transaction.
java.lang.String	getRepositoryId() Returns the ID of the repository associated with this transaction.
Sandbox	getSandbox() Returns the sandbox associated with this transaction.
SandboxTransaction.State	getState() Returns the state of this transaction, or null if the state is unknown.
boolean	isPendingResume() Returns true if this transaction is waiting to be resumed.
void	resume(ChangeHint hint) Resumes the operation that produced this transaction, or does nothing when this transaction is either ready for finalization or already finalized.

Methods inherited from class oracle.adf.share.sandbox.UndoableChanges

commit, getSummary, iterator, undo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

SandboxTransaction

protected SandboxTransaction(Sandbox sandbox,
                             java.lang.String reposId,
                             java.lang.String transId)

Creates a sandbox transaction.

Parameters:

sandbox - the sandbox

reposId - the ID of the repository in the sandbox

transId - the ID of this transaction

Throws:

java.lang.IllegalArgumentException - if any of the arguments is null

SandboxTransaction

protected SandboxTransaction(Sandbox sandbox,
                             java.lang.String reposId)

Creates a sandbox transaction with UUID.randomUUID() as the transaction ID.

Parameters:

sandbox - the sandbox

reposId - the ID of the repository

Throws:

java.lang.IllegalArgumentException - if any of the IDs is null

Method Detail

getSandbox

public final Sandbox getSandbox()

Returns the sandbox associated with this transaction.

Returns:

the sandbox

getRepositoryId

public final java.lang.String getRepositoryId()

Returns the ID of the repository associated with this transaction.

Returns:

the ID of the repository

getId

public final java.lang.String getId()

Returns the ID of this transaction.

Returns:

the ID of this transaction

resume

public void resume(ChangeHint hint)
            throws MergeConflictsException,
                   SandboxException

Resumes the operation that produced this transaction, or does nothing when this transaction is either ready for finalization or already finalized.

Parameters:

hint - a hint about how the changes should be made. Generally ChangeHint.ACCEPT_ALL_CHANGES implies this operation should continue and be completed without further input. ChangeHint.STOP_AT_CONFLICTS means a MergeConflictsException must be thrown when any conflict is detected. The change hint may be null; in that case, this method may choose to do nothing and make sure isPendingResume() return true, so that the operation will not complete until a hint is given.

Throws:

MergeConflictsException - if any conflict occurs during the operation and the operation is considered completed. Conflicts that may be resolved in the next resume should be returned normally as a ChangeSet. Any exception thrown from this method will put this transaction in a "complete" state and this method will no longer be called once the transaction is in a "complete" state.

SandboxException - if any error occurs during the operation

See Also:

isPendingResume()

isPendingResume

public boolean isPendingResume()

Returns true if this transaction is waiting to be resumed. By default this method returns true if getState() returns a state that starts with PENDING_.

Returns:

true if this transaction is waiting to be resumed

See Also:

resume(oracle.adf.share.sandbox.ChangeHint)

getState

public SandboxTransaction.State getState()

Returns the state of this transaction, or null if the state is unknown. By default this method assumes the state of this transaction is unknown and returns null.

Returns:

the state of this transaction or null if the state is unknown