Package com.broadleafcommerce.paymentgateway.domain.enums

Enum Class DefaultSavedPaymentMethodStatuses

java.lang.Object

java.lang.Enum<DefaultSavedPaymentMethodStatuses>

com.broadleafcommerce.paymentgateway.domain.enums.DefaultSavedPaymentMethodStatuses

All Implemented Interfaces:

SavedPaymentMethodStatus, Serializable, Comparable<DefaultSavedPaymentMethodStatuses>, Constable

public enum DefaultSavedPaymentMethodStatuses
extends Enum<DefaultSavedPaymentMethodStatuses>
implements SavedPaymentMethodStatus

The default statuses for the saved payment method.

Author:

Dima Myroniuk (dmyroniuk)

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
ACTION_FAILED	The action has failed or expired.
AVAILABLE_TO_USE	The saved payment method is available to use for checkout.
AWAITING_ASYNC_RESULTS	The saved payment method is created, but we're expecting an asynchronous notification from the gateway declaring if the payment method is valid or invalid.
INVALID_PAYMENT_METHOD	It's been determined that the provided payment method is invalid & cannot be used.
REQUIRES_ACTION	The saved payment method requires an additional action to be executed.

Method Summary

Modifier and Type	Method	Description
static boolean	isActionFailed(String status)
static boolean	isAvailableToUse(String status)
static boolean	isAwaitingAsyncResults(String status)
static boolean	isInvalidPaymentMethod(String status)
static boolean	isRequiresAction(String status)
static DefaultSavedPaymentMethodStatuses	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DefaultSavedPaymentMethodStatuses[]	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.paymentgateway.domain.enums.SavedPaymentMethodStatus

name

Enum Constant Details

AVAILABLE_TO_USE

public static final DefaultSavedPaymentMethodStatuses AVAILABLE_TO_USE

The saved payment method is available to use for checkout. This status cannot be changed.

AWAITING_ASYNC_RESULTS

public static final DefaultSavedPaymentMethodStatuses AWAITING_ASYNC_RESULTS

The saved payment method is created, but we're expecting an asynchronous notification from the gateway declaring if the payment method is valid or invalid. Until this is known, the saved payment method should not be used.

REQUIRES_ACTION

public static final DefaultSavedPaymentMethodStatuses REQUIRES_ACTION

The saved payment method requires an additional action to be executed.

ACTION_FAILED

public static final DefaultSavedPaymentMethodStatuses ACTION_FAILED

The action has failed or expired. This status cannot be changed.

INVALID_PAYMENT_METHOD

public static final DefaultSavedPaymentMethodStatuses INVALID_PAYMENT_METHOD

It's been determined that the provided payment method is invalid & cannot be used.

Method Details

values

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

isAvailableToUse

public static boolean isAvailableToUse(String status)

isAwaitingAsyncResults

public static boolean isAwaitingAsyncResults(String status)

isRequiresAction

public static boolean isRequiresAction(String status)

isActionFailed

public static boolean isActionFailed(String status)

isInvalidPaymentMethod

public static boolean isInvalidPaymentMethod(String status)