com.broadleafcommerce.order.common.domain.enums

Enum DefaultTransactionManagementStates

java.lang.Object

java.lang.Enum<DefaultTransactionManagementStates>

com.broadleafcommerce.order.common.domain.enums.DefaultTransactionManagementStates

All Implemented Interfaces:

TransactionManagementState, Serializable, Comparable<DefaultTransactionManagementStates>

public enum DefaultTransactionManagementStates
extends Enum<DefaultTransactionManagementStates>
implements TransactionManagementState

Describes how a transaction is being used, if it needs to be reversed, or if it has been reversed. With these states, it's especially important to distinguish the two groups:

• Those that describe a transaction that is being used to complete a checkout
• Those that describe a transaction that is being reversed

If a transaction is being used within a checkout, then it is not eligible for reversal. If a transaction is being reversed, then it is not eligible to contribute to a successful checkout. Valid state changes include:

• AVAIL_FOR_GEN_USE -> CHECKOUT_IN_PROGRESS
• AVAIL_FOR_GEN_USE -> REQUIRES_REVERSAL
• CHECKOUT_IN_PROGRESS -> AVAIL_FOR_GEN_USE
• CHECKOUT_IN_PROGRESS -> CHECKOUT_COMPLETE
• REQUIRES_REVERSAL -> REVERSAL_IN_PROGRESS
• REVERSAL_IN_PROGRESS -> REVERSED
• REVERSAL_IN_PROGRESS -> FAILED_REVERSAL

Author:

Chris Kittrell (ckittrell)

Enum Constant Summary

Enum Constants

Enum Constant and Description
AVAIL_FOR_GEN_USE Represents a successful transaction that can contribute to a successful checkout, or is able to be reversed.
CHECKOUT_COMPLETE Represents a transaction that has contributed to a successful checkout.
CHECKOUT_IN_PROGRESS Represents a transaction that is being actively used within a checkout.
FAILED_REVERSAL Represents a transaction that was not able to be reversed.
REQUIRES_REVERSAL Represents a transaction that is needs to be reversed.
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 and Description
static boolean	isAvailableForGeneralUse(String transactionManagementState)
static boolean	isCheckoutComplete(String transactionManagementState)
static boolean	isCheckoutInProgress(String transactionManagementState)
static boolean	isFailedReversal(String transactionManagementState)
static boolean	isRequiresReversal(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 type with the specified name.
static DefaultTransactionManagementStates[]	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

Methods inherited from interface com.broadleafcommerce.order.common.domain.enums.TransactionManagementState

name

Enum Constant Detail

AVAIL_FOR_GEN_USE

public static final DefaultTransactionManagementStates AVAIL_FOR_GEN_USE

Represents a successful transaction that can contribute to a successful checkout, or is able to be reversed.

CHECKOUT_IN_PROGRESS

public static final DefaultTransactionManagementStates CHECKOUT_IN_PROGRESS

Represents a transaction that is being actively used within a checkout. In this state, reversal is not possible.

CHECKOUT_COMPLETE

public static final DefaultTransactionManagementStates CHECKOUT_COMPLETE

Represents a transaction that has contributed to a successful checkout.

REQUIRES_REVERSAL

public static final DefaultTransactionManagementStates REQUIRES_REVERSAL

Represents a transaction that is needs to be 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 Detail

values

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

Returns:

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

valueOf

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

isAvailableForGeneralUse

public static boolean isAvailableForGeneralUse(String transactionManagementState)

isCheckoutInProgress

public static boolean isCheckoutInProgress(String transactionManagementState)

isCheckoutComplete

public static boolean isCheckoutComplete(String transactionManagementState)

isRequiresReversal

public static boolean isRequiresReversal(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)