Package com.broadleafcommerce.cart.client.domain.enums

Enum Class DefaultCartPaymentStatus

java.lang.Object

java.lang.Enum<DefaultCartPaymentStatus>

com.broadleafcommerce.cart.client.domain.enums.DefaultCartPaymentStatus

All Implemented Interfaces:

CartPaymentStatus, Serializable, Comparable<DefaultCartPaymentStatus>, Constable

public enum DefaultCartPaymentStatus
extends Enum<DefaultCartPaymentStatus>
implements CartPaymentStatus

Enumerates the kinds of statuses that could be represented by a cart's payments.

Author:

Chris Kittrell (ckittrell), Jacob Mitash

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
AUTHORIZED	This is equivalent to having a successful authorized transaction on the payment, but there are no transactions indicating that payment has been captured.
AUTHORIZED_REVERSED	This is equivalent to having a successful authorized transaction on the payment, but a second transaction was executed to reverse the authorization.
CAPTURED	This is equivalent to having a successfully captured transaction on the payment, and there are no transactions indicating that payment has had any reversals issued against it.
CAPTURED_REVERSED	This is equivalent to having a successfully captured transaction on the payment, but the transaction has been reversed via a void, refund, or other type of reversal.
PENDING	This represents the state where payment data has been gathered, but a payment gateway transaction is intentionally being delayed for a later time.
REQUIRES_3DS_VERIFICATION	This represents the state where payment data has been gathered, but a payment gateway has requested 3DS verification from the customer before the transaction can be executed.
UNCONFIRMED	This represents the state where the customer has not yet authorized the completion of the payment

Method Summary

Modifier and Type	Method	Description
static boolean	isAuthorized(String status)
static boolean	isAuthorizedReversed(String status)
static boolean	isCaptured(String status)
static boolean	isCapturedReversed(String status)
static boolean	isPending(String status)
static boolean	isRequires3DSVerification(String status)
static boolean	isUnconfirmed(String status)
static DefaultCartPaymentStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DefaultCartPaymentStatus[]	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.cart.client.domain.enums.CartPaymentStatus

name

Enum Constant Details

UNCONFIRMED

public static final DefaultCartPaymentStatus UNCONFIRMED

This represents the state where the customer has not yet authorized the completion of the payment

REQUIRES_3DS_VERIFICATION

public static final DefaultCartPaymentStatus REQUIRES_3DS_VERIFICATION

This represents the state where payment data has been gathered, but a payment gateway has requested 3DS verification from the customer before the transaction can be executed.

PENDING

public static final DefaultCartPaymentStatus PENDING

This represents the state where payment data has been gathered, but a payment gateway transaction is intentionally being delayed for a later time.

AUTHORIZED

public static final DefaultCartPaymentStatus AUTHORIZED

This is equivalent to having a successful authorized transaction on the payment, but there are no transactions indicating that payment has been captured.

AUTHORIZED_REVERSED

public static final DefaultCartPaymentStatus AUTHORIZED_REVERSED

This is equivalent to having a successful authorized transaction on the payment, but a second transaction was executed to reverse the authorization.

CAPTURED

public static final DefaultCartPaymentStatus CAPTURED

This is equivalent to having a successfully captured transaction on the payment, and there are no transactions indicating that payment has had any reversals issued against it.

CAPTURED_REVERSED

public static final DefaultCartPaymentStatus CAPTURED_REVERSED

This is equivalent to having a successfully captured transaction on the payment, but the transaction has been reversed via a void, refund, or other type of reversal.

Method Details

values

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

isUnconfirmed

public static boolean isUnconfirmed(String status)

isRequires3DSVerification

public static boolean isRequires3DSVerification(String status)

isPending

public static boolean isPending(String status)

isAuthorized

public static boolean isAuthorized(String status)

isAuthorizedReversed

public static boolean isAuthorizedReversed(String status)

isCaptured

public static boolean isCaptured(String status)

isCapturedReversed

public static boolean isCapturedReversed(String status)