org.osid.transaction

Enum TransactionState

java.lang.Object

java.lang.Enum<TransactionState>

org.osid.transaction.TransactionState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TransactionState>

public enum TransactionState
extends java.lang.Enum<TransactionState>

This enumeration contains the possible state values of an OsidTransaction.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABORTED the transaction has been aborted.
COMMIT_READY prepare() was successful and ready for a commit() or an abort()
COMMITTED the transaction committed successfully
START transaction has started and operations may be recorded

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDescription()
java.lang.String	getDisplayName()
static TransactionState	valueOf(java.lang.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

START

public static final TransactionState START

transaction has started and operations may be recorded

COMMIT_READY

public static final TransactionState COMMIT_READY

prepare() was successful and ready for a commit() or an abort()

COMMITTED

public static final TransactionState COMMITTED

the transaction committed successfully

ABORTED

public static final TransactionState ABORTED

the transaction has been aborted. The implementation may set an ABORTED state if an error in processing the transaction has occurred.

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(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getDisplayName

public java.lang.String getDisplayName()

getDescription

public java.lang.String getDescription()