Package com.broadleafcommerce.paymenttransaction.domain.enums

Enum Class DefaultTransactionStatuses

java.lang.Object

java.lang.Enum<DefaultTransactionStatuses>

com.broadleafcommerce.paymenttransaction.domain.enums.DefaultTransactionStatuses

All Implemented Interfaces:

TransactionStatus, Serializable, Comparable<DefaultTransactionStatuses>, Constable

public enum DefaultTransactionStatuses
extends Enum<DefaultTransactionStatuses>
implements TransactionStatus

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
AWAITING_ASYNC_RESULTS	The transaction request was successfully queued by the gateway, but transaction results will be communicated asynchronously.
EXPIRED	The transaction was successfully processed, but has since expired.
FAILURE	The payment gateway failed to successfully process the transaction.
SENDING_TO_PROCESSOR	The payment gateway call is being prepared, or has been made and we don't know the response yet.
SUCCESS	The transaction was successfully processed by the payment gateway.

Method Summary

Modifier and Type	Method	Description
static boolean	isAwaitingAsyncResults(String transactionStatus)
static boolean	isExpired(String transactionStatus)
static boolean	isFailure(String transactionStatus)
static boolean	isSendingToProcessor(String transactionStatus)
static boolean	isSuccess(String transactionStatus)
static DefaultTransactionStatuses	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DefaultTransactionStatuses[]	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.TransactionStatus

name

Enum Constant Details

SENDING_TO_PROCESSOR

public static final DefaultTransactionStatuses SENDING_TO_PROCESSOR

The payment gateway call is being prepared, or has been made and we don't know the response yet. Transactions can remain in this status if the application restarts or if we encounter an unexpected network failure.

SUCCESS

public static final DefaultTransactionStatuses SUCCESS

The transaction was successfully processed by the payment gateway.

AWAITING_ASYNC_RESULTS

public static final DefaultTransactionStatuses AWAITING_ASYNC_RESULTS

The transaction request was successfully queued by the gateway, but transaction results will be communicated asynchronously.

FAILURE

public static final DefaultTransactionStatuses FAILURE

The payment gateway failed to successfully process the transaction. This primarily represents a declined payment.

EXPIRED

public static final DefaultTransactionStatuses EXPIRED

The transaction was successfully processed, but has since expired. The most common use case for this status is the expiration of a successful authorization transaction.

Method Details

values

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

isSendingToProcessor

public static boolean isSendingToProcessor(String transactionStatus)

isSuccess

public static boolean isSuccess(String transactionStatus)

isAwaitingAsyncResults

public static boolean isAwaitingAsyncResults(String transactionStatus)

isFailure

public static boolean isFailure(String transactionStatus)

isExpired

public static boolean isExpired(String transactionStatus)