org.apache.isis.applib.services.xactn

Enum TransactionState

java.lang.Object

java.lang.Enum<TransactionState>

org.apache.isis.applib.services.xactn.TransactionState

All Implemented Interfaces:

Serializable, Comparable<TransactionState>

public enum TransactionState
extends Enum<TransactionState>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABORTED Completed, having aborted.
COMMITTED Completed, having successfully committed.
IN_PROGRESS Started, still in progress.
MUST_ABORT Started, but has hit an exception.
NONE No transaction exists.

Method Summary

Modifier and Type	Method and Description
boolean	canAbort() Whether it is valid to mark as aborted this transaction}.
boolean	canCommit() Whether it is valid to commit the transaction.
boolean	canFlush() Whether it is valid to flush the transaction.
boolean	isComplete() Whether the transaction is complete (and so a new one can be started).
boolean	mustAbort()
static TransactionState	valueOf(String name) Returns the enum constant of this type with the specified name.
static TransactionState[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final TransactionState NONE

No transaction exists.

IN_PROGRESS

public static final TransactionState IN_PROGRESS

Started, still in progress.

May flush, commit or abort.

MUST_ABORT

public static final TransactionState MUST_ABORT

Started, but has hit an exception.

May not flush or commit (will throw an IllegalStateException), can only abort.

Similar to setRollbackOnly in EJBs.

COMMITTED

public static final TransactionState COMMITTED

Completed, having successfully committed.

May not flush or abort or commit (will throw IllegalStateException).

ABORTED

public static final TransactionState ABORTED

Completed, having aborted.

May not flush, commit or abort (will throw IllegalStateException).

Method Detail

values

public static TransactionState[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TransactionState c : TransactionState.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TransactionState valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

canFlush

public boolean canFlush()

Whether it is valid to flush the transaction.

canCommit

public boolean canCommit()

Whether it is valid to commit the transaction.

canAbort

public boolean canAbort()

Whether it is valid to mark as aborted this transaction}.

isComplete

public boolean isComplete()

Whether the transaction is complete (and so a new one can be started).

mustAbort

public boolean mustAbort()