Enum Class TransactionState

java.lang.Object

java.lang.Enum<TransactionState>

org.osid.transaction.TransactionState

All Implemented Interfaces:

Serializable, Comparable<TransactionState>, Constable

public enum TransactionState
extends Enum<TransactionState>

This enumeration contains the possible state values of an OsidTransaction .

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	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

Modifier and Type	Method	Description
String	getDescription()
String	getDisplayName()
static TransactionState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TransactionState[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

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 Details

values

public static TransactionState[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static TransactionState valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getDisplayName

public String getDisplayName()

getDescription

public String getDescription()