Package org.jboss.narayana.compensations.api

Enum CompensationTransactionType

java.lang.Object

java.lang.Enum<CompensationTransactionType>

org.jboss.narayana.compensations.api.CompensationTransactionType

All Implemented Interfaces:

Serializable, Comparable<CompensationTransactionType>

public enum CompensationTransactionType
extends Enum<CompensationTransactionType>

Indicates whether a bean method is to be executed within a transaction context where the values provide the following corresponding behavior.

Author:

[email protected] 21/03/2013

Enum Constant Summary

Enum Constants

Enum Constant	Description
MANDATORY	If called outside a transaction context, a TransactionalException with a nested TransactionRequiredException must be thrown.
NEVER	If called outside a transaction context, managed bean method execution must then continue outside a transaction context.
NOT_SUPPORTED	If called outside a transaction context, managed bean method execution must then continue outside a transaction context.
REQUIRED	If called outside a transaction context, the interceptor must begin a new compensation-based transaction, the managed bean method execution must then continue inside this transaction context, and the transaction must be completed by the interceptor.
REQUIRES_NEW	If called outside a transaction context, the interceptor must begin a new compensation-based transaction, the managed bean method execution must then continue inside this transaction context, and the transaction must be completed by the interceptor.
SUPPORTS	If called outside a transaction context, managed bean method execution must then continue outside a transaction context.

Method Summary

Modifier and Type	Method	Description
static CompensationTransactionType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CompensationTransactionType[]	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

REQUIRED

public static final CompensationTransactionType REQUIRED

If called outside a transaction context, the interceptor must begin a new compensation-based transaction, the managed bean method execution must then continue inside this transaction context, and the transaction must be completed by the interceptor.

If called inside a compensation-based transaction context, the managed bean method execution must then continue inside this transaction context.

REQUIRES_NEW

public static final CompensationTransactionType REQUIRES_NEW

If called outside a transaction context, the interceptor must begin a new compensation-based transaction, the managed bean method execution must then continue inside this transaction context, and the transaction must be completed by the interceptor.

If called inside a compensation-based transaction context, the current transaction context must be suspended, a new compensation-based transaction will begin, the managed bean method execution must then continue inside this transaction context, the transaction must be completed, and the previously suspended transaction must be resumed.

MANDATORY

public static final CompensationTransactionType MANDATORY

If called outside a transaction context, a TransactionalException with a nested TransactionRequiredException must be thrown.

If called inside a compensation-based transaction context, managed bean method execution will then continue under that context.

SUPPORTS

public static final CompensationTransactionType SUPPORTS

If called outside a transaction context, managed bean method execution must then continue outside a transaction context.

If called inside a transaction context, the managed bean method execution must then continue inside this transaction context.

NOT_SUPPORTED

public static final CompensationTransactionType NOT_SUPPORTED

If called outside a transaction context, managed bean method execution must then continue outside a transaction context.

If called inside a compensation-based transaction context, the current transaction context must be suspended, the managed bean method execution must then continue outside a transaction context, and the previously suspended transaction must be resumed by the interceptor that suspended it after the method execution has completed.

NEVER

public static final CompensationTransactionType NEVER

If called outside a transaction context, managed bean method execution must then continue outside a transaction context.

If called inside a compensation-based transaction context, a TransactionalException with a nested InvalidTransactionException must be thrown.

Method Detail

values

public static CompensationTransactionType[] 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 (CompensationTransactionType c : CompensationTransactionType.values())
    System.out.println(c);

Returns:

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

valueOf

public static CompensationTransactionType 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