org.jboss.seam.transaction
Enum TransactionPropagation

java.lang.Object
  extended by java.lang.Enum<TransactionPropagation>
      extended by org.jboss.seam.transaction.TransactionPropagation
All Implemented Interfaces:
Serializable, Comparable<TransactionPropagation>

public enum TransactionPropagation
extends Enum<TransactionPropagation>

Author:
Dan Allen

Enum Constant Summary
MANDATORY
          Requires a transaction to be active.
NEVER
          Requires no transaction to be active.
REQUIRED
          A transaction will be started if one is not currently active.
SUPPORTS
          A transaction will not be started if there is not one currently active, however this method supports running inside an existing transaction
 
Method Summary
 boolean isNewTransactionRequired(boolean transactionActive)
           
static TransactionPropagation valueOf(String name)
          Returns the enum constant of this type with the specified name.
static TransactionPropagation[] 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 TransactionPropagation REQUIRED
A transaction will be started if one is not currently active.


SUPPORTS

public static final TransactionPropagation SUPPORTS
A transaction will not be started if there is not one currently active, however this method supports running inside an existing transaction


MANDATORY

public static final TransactionPropagation MANDATORY
Requires a transaction to be active. If no transaction is active an IllegalStateException is thrown


NEVER

public static final TransactionPropagation NEVER
Requires no transaction to be active. If a transaction is active an IllegalStateException is thrown

Method Detail

values

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

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

valueOf

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

isNewTransactionRequired

public boolean isNewTransactionRequired(boolean transactionActive)


Copyright © 2011 Seam Framework. All Rights Reserved.