Package com.broadleafcommerce.paymenttransaction.domain.enums

Enum Class DefaultTransactionReversalStatuses

java.lang.Object

java.lang.Enum<DefaultTransactionReversalStatuses>

com.broadleafcommerce.paymenttransaction.domain.enums.DefaultTransactionReversalStatuses

All Implemented Interfaces:

TransactionReversalStatus, Serializable, Comparable<DefaultTransactionReversalStatuses>, Constable

public enum DefaultTransactionReversalStatuses
extends Enum<DefaultTransactionReversalStatuses>
implements TransactionReversalStatus

Describes the result of a PaymentTransaction's reversal.

Author:

Chris Kittrell (ckittrell)

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FAILURE	The transaction reversal was not successful.
SHOULD_RETRY	The reversal was either not attempted or not successful, and should be retried at a later time.
SUCCESS	The transaction reversal was successfully executed.

Method Summary

Modifier and Type	Method	Description
static boolean	isFailure(String transactionReversalState)
static boolean	isSuccess(String transactionReversalState)
static boolean	shouldRetry(String transactionReversalState)
static DefaultTransactionReversalStatuses	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DefaultTransactionReversalStatuses[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.broadleafcommerce.paymenttransaction.domain.enums.TransactionReversalStatus

name

Enum Constant Details

SUCCESS

public static final DefaultTransactionReversalStatuses SUCCESS

The transaction reversal was successfully executed.

FAILURE

public static final DefaultTransactionReversalStatuses FAILURE

The transaction reversal was not successful.

SHOULD_RETRY

public static final DefaultTransactionReversalStatuses SHOULD_RETRY

The reversal was either not attempted or not successful, and should be retried at a later time.

Method Details

values

public static DefaultTransactionReversalStatuses[] 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 DefaultTransactionReversalStatuses 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

isSuccess

public static boolean isSuccess(String transactionReversalState)

isFailure

public static boolean isFailure(String transactionReversalState)

shouldRetry

public static boolean shouldRetry(String transactionReversalState)