Package com.broadleafcommerce.paymenttransaction.domain.enums

Enum Class DefaultTransactionManagementStates

java.lang.Object

java.lang.Enum<DefaultTransactionManagementStates>

com.broadleafcommerce.paymenttransaction.domain.enums.DefaultTransactionManagementStates

All Implemented Interfaces:

TransactionManagementState, Serializable, Comparable<DefaultTransactionManagementStates>, Constable

public enum DefaultTransactionManagementStates
extends Enum<DefaultTransactionManagementStates>
implements TransactionManagementState

Describes how a transaction is being used, esp. if it needs to be reversed or if it has been reversed.

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
AUTOMATIC_REVERSAL_NOT_ALLOWED	Represents a transaction that cannot be reversed automatically by scheduled jobs.
FAILED_REVERSAL	Represents a transaction that was not able to be reversed.
REQUIRES_REVERSAL	Represents a transaction that is needs to be reversed.
REVERSAL_CANDIDATE	Represents a transaction that is eligible to be reversed, but before the reversal is processed, the transaction can be used.
REVERSAL_IN_PROGRESS	Represents a transaction that is being actively reversed.
REVERSAL_TRANSACTION	Represents a transaction that reversed another transaction.
REVERSED	Represents a transaction that has been successfully reversed.

Method Summary

Modifier and Type	Method	Description
static boolean	isAutomaticReversalNotAllowed(String transactionManagementState)
static boolean	isFailedReversal(String transactionManagementState)
static boolean	isRequiresReversal(String transactionManagementState)
static boolean	isReversalCandidate(String transactionManagementState)
static boolean	isReversalInProgress(String transactionManagementState)
static boolean	isReversalTransaction(String transactionManagementState)
static boolean	isReversed(String transactionManagementState)
static boolean	isReversedOrReversalTransaction(String managementState)
static DefaultTransactionManagementStates	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DefaultTransactionManagementStates[]	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.TransactionManagementState

name

Enum Constant Details

AUTOMATIC_REVERSAL_NOT_ALLOWED

public static final DefaultTransactionManagementStates AUTOMATIC_REVERSAL_NOT_ALLOWED

Represents a transaction that cannot be reversed automatically by scheduled jobs. For example, an AUTHORIZE transaction can be reversed by executing a REVERSE_AUTHORIZE transaction by an external system. However, it will not be picked up by the CheckoutRollbackEventListener listener and PaymentTransactionReversalJobListener job.

REQUIRES_REVERSAL

public static final DefaultTransactionManagementStates REQUIRES_REVERSAL

Represents a transaction that is needs to be reversed.

REVERSAL_CANDIDATE

public static final DefaultTransactionManagementStates REVERSAL_CANDIDATE

Represents a transaction that is eligible to be reversed, but before the reversal is processed, the transaction can be used. If this is done, then the PaymentTransaction.getManagementState() must be cleared, so that the transaction is not reversed.

REVERSAL_IN_PROGRESS

public static final DefaultTransactionManagementStates REVERSAL_IN_PROGRESS

Represents a transaction that is being actively reversed.

REVERSED

public static final DefaultTransactionManagementStates REVERSED

Represents a transaction that has been successfully reversed.

FAILED_REVERSAL

public static final DefaultTransactionManagementStates FAILED_REVERSAL

Represents a transaction that was not able to be reversed. This state likely requires manual review & reconciliation.

REVERSAL_TRANSACTION

public static final DefaultTransactionManagementStates REVERSAL_TRANSACTION

Represents a transaction that reversed another transaction.

Method Details

values

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

isAutomaticReversalNotAllowed

public static boolean isAutomaticReversalNotAllowed(String transactionManagementState)

isRequiresReversal

public static boolean isRequiresReversal(String transactionManagementState)

isReversalCandidate

public static boolean isReversalCandidate(String transactionManagementState)

isReversalInProgress

public static boolean isReversalInProgress(String transactionManagementState)

isReversed

public static boolean isReversed(String transactionManagementState)

isFailedReversal

public static boolean isFailedReversal(String transactionManagementState)

isReversalTransaction

public static boolean isReversalTransaction(String transactionManagementState)

isReversedOrReversalTransaction

public static boolean isReversedOrReversalTransaction(String managementState)