Package com.broadleafcommerce.cartoperation.domain.enums

Enum Class DefaultExternalPaymentInteractionResult

java.lang.Object

java.lang.Enum<DefaultExternalPaymentInteractionResult>

com.broadleafcommerce.cartoperation.domain.enums.DefaultExternalPaymentInteractionResult

All Implemented Interfaces:

ExternalPaymentInteractionResult, Serializable, Comparable<DefaultExternalPaymentInteractionResult>, Constable

public enum DefaultExternalPaymentInteractionResult
extends Enum<DefaultExternalPaymentInteractionResult>
implements ExternalPaymentInteractionResult

Describes the result of an external payment interaction like 3DS or a hosted payment page interaction.

Author:

Chris Kittrell (ckittrell)

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
PAYMENT_CANCELED	The customer has decided to exit the external payment interaction, & therefore, the usage of the payment method is canceled.
PAYMENT_EXPIRED	The customer did not complete the external payment interaction (e.g.
PAYMENT_FAILED	The external payment interaction failed.
SUCCESS	The external payment interaction was successful.
UNKNOWN	The result of the external payment interaction could not be determined.

Method Summary

Modifier and Type	Method	Description
static boolean	isPaymentCanceled(String externalPaymentInteractionResult)
static boolean	isPaymentExpired(String externalPaymentInteractionResult)
static boolean	isPaymentFailed(String externalPaymentInteractionResult)
static boolean	isSuccess(String externalPaymentInteractionResult)
static boolean	isUnknown(String externalPaymentInteractionResult)
static DefaultExternalPaymentInteractionResult	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DefaultExternalPaymentInteractionResult[]	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.cartoperation.domain.enums.ExternalPaymentInteractionResult

name

Enum Constant Details

SUCCESS

public static final DefaultExternalPaymentInteractionResult SUCCESS

The external payment interaction was successful. This represents both a successful interaction (3DS or HPP) & a successful transaction.

PAYMENT_FAILED

public static final DefaultExternalPaymentInteractionResult PAYMENT_FAILED

The external payment interaction failed. This is meant to represent things like failed 3DS verification or a failed transaction following successful 3DS or HPP interaction.

PAYMENT_CANCELED

public static final DefaultExternalPaymentInteractionResult PAYMENT_CANCELED

The customer has decided to exit the external payment interaction, & therefore, the usage of the payment method is canceled.

PAYMENT_EXPIRED

public static final DefaultExternalPaymentInteractionResult PAYMENT_EXPIRED

The customer did not complete the external payment interaction (e.g. 3DS verification or HPP) before it expired. Therefore, the payment is no longer usable.

UNKNOWN

public static final DefaultExternalPaymentInteractionResult UNKNOWN

The result of the external payment interaction could not be determined. This is typically the case if an unexpected exception was encountered.

Method Details

values

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

isSuccess

public static boolean isSuccess(String externalPaymentInteractionResult)

isPaymentFailed

public static boolean isPaymentFailed(String externalPaymentInteractionResult)

isPaymentCanceled

public static boolean isPaymentCanceled(String externalPaymentInteractionResult)

isPaymentExpired

public static boolean isPaymentExpired(String externalPaymentInteractionResult)

isUnknown

public static boolean isUnknown(String externalPaymentInteractionResult)