Enum Class DefaultCheckoutFailureTypes
java.lang.Object
java.lang.Enum<DefaultCheckoutFailureTypes>
com.broadleafcommerce.cartoperation.domain.DefaultCheckoutFailureTypes
- All Implemented Interfaces:
CheckoutFailureType
,Serializable
,Comparable<DefaultCheckoutFailureTypes>
,Constable
public enum DefaultCheckoutFailureTypes
extends Enum<DefaultCheckoutFailureTypes>
implements CheckoutFailureType
The default set of
checkoutFailureTypes
used to categorize the reason
that a checkout submission failed.- 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 ConstantDescriptionThe validation of the cart's payment(s) failed because a credit account payment is present and is lacking funds.The current checkout request ID is a duplicate within the cart's checkout IDsAn error was encountered while finalizing the cart.An error was encountered while performing checkout rollback.An inventory check against the cart's items failed.The execution of transactions for the cart's payment(s) failed.Represents an unexpected error during the processing of the checkout submission.If the cart is using campaign codes, the usage of those codes must still be valid when the customer attempts to checkout.There is invalid fulfillment data and therefore it is unclear how each cart item should be fulfilled once the checkout is complete.There is missing fulfillment data and therefore it is unclear how each cart item should be fulfilled once the checkout is complete.There is invalid or missing cart item information and therefore it is unclear what the customer is attempting to purchase.The cart and all of its items must have finalized pricing before the checkout can be processed.The cart is in an invalid status to complete checkout.If the cart is using offers or offer codes, the usage of those offers or offer codes must still be valid when the customer attempts to checkout.The cart must have valid payments and the sum of those payment amounts must be equal to the order total.The confirmation of the cart's payment(s) failed because 3DS verification is required.The confirmation of the cart's payment(s) failed because external details are required.An error was encountered while sending the cart awaiting payment result event.An error was encountered while sending the checkout completion event.The cart contains the stale cart items - i.e.The cart pricing is out of date and the latest prices are higher than they previously were.The cart pricing is out of date and the latest prices are lower than they previously were. -
Method Summary
Modifier and TypeMethodDescriptionstatic boolean
isCreditAccountInsufficientBalanceFailure
(String failureType) static boolean
isDuplicateRequestId
(String failureType) static boolean
isFailedCartFinalization
(String failureType) static boolean
isFailedCheckoutRollback
(String failureType) static boolean
isFailedPaymentTransaction
(String failureType) static boolean
isInternalError
(String failureType) static boolean
isInvalidCampaignCodeUsageFailure
(String failureType) static boolean
isInvalidCartFulfillmentConfigFailure
(String failureType) static boolean
isInvalidCartFulfillmentMissingFailure
(String failureType) static boolean
isInvalidCartItemConfigFailure
(String failureType) static boolean
isInvalidCartPricingFailure
(String failureType) static boolean
isInvalidCartStatusFailure
(String failureType) static boolean
isInvalidOfferOrOfferCodeUsageFailure
(String failureType) static boolean
isInvalidPaymentConfigFailure
(String failureType) static boolean
isPaymentRequires3dsVerification
(String failureType) static boolean
isPaymentRequiresExternalInteraction
(String failureType) static boolean
isSendCartAwaitingPaymentResultsEventError
(String failureType) static boolean
isSendCheckoutCompletionEventError
(String failureType) static boolean
isStaleCartItemFailure
(String failureType) static boolean
isStaleCartPricingHigher
(String failureType) static boolean
isStaleCartPricingLower
(String failureType) static DefaultCheckoutFailureTypes
Returns the enum constant of this class with the specified name.static DefaultCheckoutFailureTypes[]
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 interface com.broadleafcommerce.cartoperation.domain.CheckoutFailureType
name
-
Enum Constant Details
-
INTERNAL_ERROR
Represents an unexpected error during the processing of the checkout submission. -
DUPLICATE_REQUEST_ID
The current checkout request ID is a duplicate within the cart's checkout IDs -
INVALID_CART_STATUS
The cart is in an invalid status to complete checkout. -
INVALID_CART_ITEM_CONFIG
There is invalid or missing cart item information and therefore it is unclear what the customer is attempting to purchase. -
INVALID_CART_FULFILLMENT_CONFIG
There is invalid fulfillment data and therefore it is unclear how each cart item should be fulfilled once the checkout is complete. -
INVALID_CART_FULFILLMENT_MISSING
There is missing fulfillment data and therefore it is unclear how each cart item should be fulfilled once the checkout is complete. -
INVALID_CART_PRICING
The cart and all of its items must have finalized pricing before the checkout can be processed. -
STALE_CART_PRICING_HIGHER
The cart pricing is out of date and the latest prices are higher than they previously were. -
STALE_CART_PRICING_LOWER
The cart pricing is out of date and the latest prices are lower than they previously were. -
STALE_CART_ITEM
The cart contains the stale cart items - i.e. the product is no longer present in the catalog. -
INVALID_PAYMENT_CONFIG
The cart must have valid payments and the sum of those payment amounts must be equal to the order total. -
INVALID_OFFER_OR_OFFER_CODE_USAGE
If the cart is using offers or offer codes, the usage of those offers or offer codes must still be valid when the customer attempts to checkout. This is primarily relevant for offers and offer codes that include maximum usage configuration. These offers or offer codes must be removed from the cart before checkout can be completed. -
INVALID_CAMPAIGN_CODE_USAGE
If the cart is using campaign codes, the usage of those codes must still be valid when the customer attempts to checkout. This is primarily relevant for campaign codes that include maximum usage configuration. These campaign codes must be removed from the cart before checkout can be completed. -
FAILED_INVENTORY_CHECK
An inventory check against the cart's items failed. Therefore, checkout cannot be completed. -
PAYMENT_REQUIRES_3DS_VERIFICATION
The confirmation of the cart's payment(s) failed because 3DS verification is required. Once the verification is completed, the related payment can contribute to a successful checkout. -
FAILED_PAYMENT_TRANSACTION
The execution of transactions for the cart's payment(s) failed. Therefore, checkout cannot be completed. -
FAILED_CART_FINALIZATION
An error was encountered while finalizing the cart. -
FAILED_CHECKOUT_ROLLBACK
An error was encountered while performing checkout rollback. -
SEND_CHECKOUT_COMPLETION_EVENT_ERROR
An error was encountered while sending the checkout completion event. -
SEND_CART_AWAITING_PAYMENT_RESULTS_EVENT_ERROR
An error was encountered while sending the cart awaiting payment result event. -
CREDIT_ACCOUNT_INSUFFICIENT_BALANCE
The validation of the cart's payment(s) failed because a credit account payment is present and is lacking funds. -
PAYMENT_REQUIRES_EXTERNAL_INTERACTION
The confirmation of the cart's payment(s) failed because external details are required. Once the interaction is completed and the transaction details recorded on the payment, the related payment can contribute to a successful checkout.
-
-
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
-
isInternalError
-
isDuplicateRequestId
-
isInvalidCartStatusFailure
-
isInvalidCartItemConfigFailure
-
isInvalidCartFulfillmentConfigFailure
-
isInvalidCartFulfillmentMissingFailure
-
isInvalidCartPricingFailure
-
isStaleCartPricingHigher
-
isStaleCartPricingLower
-
isInvalidPaymentConfigFailure
-
isInvalidOfferOrOfferCodeUsageFailure
-
isInvalidCampaignCodeUsageFailure
-
isPaymentRequires3dsVerification
-
isFailedPaymentTransaction
-
isFailedCartFinalization
-
isFailedCheckoutRollback
-
isSendCheckoutCompletionEventError
-
isSendCartAwaitingPaymentResultsEventError
-
isStaleCartItemFailure
-
isCreditAccountInsufficientBalanceFailure
-
isPaymentRequiresExternalInteraction
-
getMessagePath
- Specified by:
getMessagePath
in interfaceCheckoutFailureType
-