com.broadleafcommerce.paymentgateway.domain.enums

Enum DefaultTransactionFailureTypes

java.lang.Object

java.lang.Enum<DefaultTransactionFailureTypes>

com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionFailureTypes

All Implemented Interfaces:

TransactionFailureType, Serializable, Comparable<DefaultTransactionFailureTypes>

public enum DefaultTransactionFailureTypes
extends Enum<DefaultTransactionFailureTypes>
implements TransactionFailureType

The default set of transactionFailureTypes that we expect to encounter with payment gateway interactions

Author:

Chris Kittrell (ckittrell)

Enum Constant Summary

Enum Constants

Enum Constant and Description
API_RATE_LIMIT_ERROR An error that occurs when too many requests hit the gateway's API too quickly
GATEWAY_CREDENTIALS_ERROR The provided payment gateway credentials are not valid
GATEWAY_ERROR There was an unexpected error with the payment gateway itself.
INTERNAL_ERROR There was an error in our preparation of the gateway interaction or in our interpretation/storing of the response.
INVALID_REQUEST There was a failure to process the request because the request itself is invalid.
NETWORK_ERROR There was an error in communicating with the payment gateway.
PROCESSING_FAILURE The payment gateway failed to successfully process the transaction.
REQUIRES_ADDITIONAL_ACTION Additional action is required from the customer for the gateway to successfully process the transaction

Method Summary

Modifier and Type	Method and Description
static boolean	isGatewayCredentialsError(String transactionStatus)
static boolean	isGatewayError(String transactionStatus)
static boolean	isInternalError(String transactionStatus)
static boolean	isInvalidRequest(String transactionStatus)
static boolean	isNetworkError(String transactionStatus)
static boolean	isProcessingFailure(String transactionStatus)
static boolean	isRequiresAdditionalActionError(String transactionStatus)
static DefaultTransactionFailureTypes	valueOf(String name) Returns the enum constant of this type with the specified name.
static DefaultTransactionFailureTypes[]	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.paymentgateway.domain.enums.TransactionFailureType

name

Enum Constant Detail

GATEWAY_CREDENTIALS_ERROR

public static final DefaultTransactionFailureTypes GATEWAY_CREDENTIALS_ERROR

The provided payment gateway credentials are not valid

INVALID_REQUEST

public static final DefaultTransactionFailureTypes INVALID_REQUEST

There was a failure to process the request because the request itself is invalid.

PROCESSING_FAILURE

public static final DefaultTransactionFailureTypes PROCESSING_FAILURE

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

REQUIRES_ADDITIONAL_ACTION

public static final DefaultTransactionFailureTypes REQUIRES_ADDITIONAL_ACTION

Additional action is required from the customer for the gateway to successfully process the transaction

GATEWAY_ERROR

public static final DefaultTransactionFailureTypes GATEWAY_ERROR

There was an unexpected error with the payment gateway itself.

NETWORK_ERROR

public static final DefaultTransactionFailureTypes NETWORK_ERROR

There was an error in communicating with the payment gateway. This can correlate to a known network failure/timeout or connection issue.

API_RATE_LIMIT_ERROR

public static final DefaultTransactionFailureTypes API_RATE_LIMIT_ERROR

An error that occurs when too many requests hit the gateway's API too quickly

INTERNAL_ERROR

public static final DefaultTransactionFailureTypes INTERNAL_ERROR

There was an error in our preparation of the gateway interaction or in our interpretation/storing of the response.

Method Detail

values

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

Returns:

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

valueOf

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

isGatewayCredentialsError

public static boolean isGatewayCredentialsError(String transactionStatus)

isInvalidRequest

public static boolean isInvalidRequest(String transactionStatus)

isProcessingFailure

public static boolean isProcessingFailure(String transactionStatus)

isRequiresAdditionalActionError

public static boolean isRequiresAdditionalActionError(String transactionStatus)

isGatewayError

public static boolean isGatewayError(String transactionStatus)

isNetworkError

public static boolean isNetworkError(String transactionStatus)

isInternalError

public static boolean isInternalError(String transactionStatus)