Package com.broadleafcommerce.orderoperation.domain.enums

Enum DefaultTransactionStatuses

java.lang.Object

java.lang.Enum<DefaultTransactionStatuses>

com.broadleafcommerce.orderoperation.domain.enums.DefaultTransactionStatuses

All Implemented Interfaces:

TransactionStatus, Serializable, Comparable<DefaultTransactionStatuses>

public enum DefaultTransactionStatuses
extends Enum<DefaultTransactionStatuses>
implements TransactionStatus

Enum Constant Summary

Enum Constants

Enum Constant	Description
EXPIRED	The transaction was successfully processed, but has since expired.
FAILURE	The payment gateway failed to successfully process the transaction.
PENDING	The transaction request was successfully handled by the gateway, but the transaction itself is not yet finalized.
REQUIRES_3DS_VERIFICATION	The transaction was received by the payment gateway, but they have requested 3DS verification from the customer before the transaction can be executed.
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	isExpired(String transactionStatus)
static boolean	isFailure(String transactionStatus)
static boolean	isPending(String transactionStatus)
static boolean	isRequires3DSVerification(String transactionStatus)
static boolean	isSendingToProcessor(String transactionStatus)
static boolean	isSuccess(String transactionStatus)
static DefaultTransactionStatuses	valueOf(String name)	Returns the enum constant of this type with the specified name.
static DefaultTransactionStatuses[]	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.orderoperation.domain.enums.TransactionStatus

name

Enum Constant Detail

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.

REQUIRES_3DS_VERIFICATION

public static final DefaultTransactionStatuses REQUIRES_3DS_VERIFICATION

The transaction was received by the payment gateway, but they have requested 3DS verification from the customer before the transaction can be executed.

SUCCESS

public static final DefaultTransactionStatuses SUCCESS

The transaction was successfully processed by the payment gateway.

PENDING

public static final DefaultTransactionStatuses PENDING

The transaction request was successfully handled by the gateway, but the transaction itself is not yet finalized. This most commonly occurs when a transaction requires 3DS verification, before the transaction can be executed by the gateway.

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 Detail

values

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

Returns:

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

valueOf

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

isSendingToProcessor

public static boolean isSendingToProcessor(String transactionStatus)

isRequires3DSVerification

public static boolean isRequires3DSVerification(String transactionStatus)

isSuccess

public static boolean isSuccess(String transactionStatus)

isPending

public static boolean isPending(String transactionStatus)

isFailure

public static boolean isFailure(String transactionStatus)

isExpired

public static boolean isExpired(String transactionStatus)