Enum Class PaymentDeclineType
java.lang.Object
java.lang.Enum<PaymentDeclineType>
com.broadleafcommerce.cartoperation.domain.enums.PaymentDeclineType
- All Implemented Interfaces:
Serializable
,Comparable<PaymentDeclineType>
,Constable
When a payment gateway declines a payment, this value indicates whether it is a "soft"
(insufficient funds) or "hard" (stolen card) decline.
Generally, soft declines may be resolved given some time, and therefore, these payment methods
can be retried. On the other hand, if a payment method receives a hard decline, then it will
continuously fail and should not be used again.
- Author:
- gdiaz, Chris Kittrell (ckittrell)
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic boolean
isHardDecline
(String declineType) static boolean
isSoftDecline
(String declineType) static PaymentDeclineType
Returns the enum constant of this class with the specified name.static PaymentDeclineType[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
SOFT
-
HARD
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
isSoftDecline
-
isHardDecline
-
getFriendlyName
-