Package com.broadleafcommerce.orderoperation.service.messaging.capture

Enum Class PaymentCaptureAttemptResultStatus

java.lang.Object

java.lang.Enum<PaymentCaptureAttemptResultStatus>

com.broadleafcommerce.orderoperation.service.messaging.capture.PaymentCaptureAttemptResultStatus

All Implemented Interfaces:

Serializable, Comparable<PaymentCaptureAttemptResultStatus>, Constable

public enum PaymentCaptureAttemptResultStatus
extends Enum<PaymentCaptureAttemptResultStatus>

The types of results that could come from attempting to capture payment on a fulfillment.

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
AWAITING_RESULT	One or more of the attempted capture transactions are awaiting payment gateway's response.
FAILURE	One of the attempted capture transactions failed.
INDETERMINATE_RESULT	One of the attempted capture transactions failed with an indeterminate result.
SUCCESS	All the attempted capture transactions succeeded.
UNNECESSARY	There was a zero total, so capturing is not necessary.

Method Summary

Modifier and Type	Method	Description
static PaymentCaptureAttemptResultStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PaymentCaptureAttemptResultStatus[]	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

Enum Constant Details

UNNECESSARY

public static final PaymentCaptureAttemptResultStatus UNNECESSARY

There was a zero total, so capturing is not necessary.

INDETERMINATE_RESULT

public static final PaymentCaptureAttemptResultStatus INDETERMINATE_RESULT

One of the attempted capture transactions failed with an indeterminate result.

SUCCESS

public static final PaymentCaptureAttemptResultStatus SUCCESS

All the attempted capture transactions succeeded.

AWAITING_RESULT

public static final PaymentCaptureAttemptResultStatus AWAITING_RESULT

One or more of the attempted capture transactions are awaiting payment gateway's response.

FAILURE

public static final PaymentCaptureAttemptResultStatus FAILURE

One of the attempted capture transactions failed.

Method Details

values

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