DefaultCheckoutFailureTypes (Broadleaf Cart Operation Services 1.6.0-GA API)

java.lang.Object
- java.lang.Enum<DefaultCheckoutFailureTypes>
- - com.broadleafcommerce.cartoperation.domain.DefaultCheckoutFailureTypes

All Implemented Interfaces:

CheckoutFailureType, Serializable, Comparable<DefaultCheckoutFailureTypes>
```
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)

Enum Constant Summary

Enum Constants
Enum Constant and Description
`DUPLICATE_REQUEST_ID` The current checkout request ID is a duplicate within the cart's checkout IDs
`FAILED_INVENTORY_CHECK` An inventory check against the cart's items failed.
`FAILED_PAYMENT_CONFIRMATION` The confirmation of the cart's payment(s) failed.
`INTERNAL_ERROR` Represents an unexpected error during the processing of the checkout submission.
`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.
`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_ITEM_CONFIG` There is invalid or missing cart item information and therefore it is unclear what the customer is attempting to purchase.
`INVALID_CART_PRICING` The cart and all of its items must have finalized pricing before the checkout can be processed.
`INVALID_CART_STATUS` The cart is in an invalid status to complete checkout.
`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.
`INVALID_PAYMENT_CONFIG` The cart must have valid payments and the sum of those payment amounts must be equal to the order total.
`PAYMENT_REQUIRES_3DS_VERIFICATION` The confirmation of the cart's payment(s) failed because 3DS verification is required.
`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.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getMessagePath()`
`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`	`isPaymentConfirmationFailure(String failureType)`
`static DefaultCheckoutFailureTypes`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static DefaultCheckoutFailureTypes[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, 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.CheckoutFailureType
name

- Enum Constant Detail
  - INTERNAL_ERROR
```
public static final DefaultCheckoutFailureTypes INTERNAL_ERROR
```
    Represents an unexpected error during the processing of the checkout submission.
  - DUPLICATE_REQUEST_ID
```
public static final DefaultCheckoutFailureTypes DUPLICATE_REQUEST_ID
```
    The current checkout request ID is a duplicate within the cart's checkout IDs
  - INVALID_CART_STATUS
```
public static final DefaultCheckoutFailureTypes INVALID_CART_STATUS
```
    The cart is in an invalid status to complete checkout.
  - INVALID_CART_ITEM_CONFIG
```
public static final DefaultCheckoutFailureTypes 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
```
public static final DefaultCheckoutFailureTypes 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
```
public static final DefaultCheckoutFailureTypes 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
```
public static final DefaultCheckoutFailureTypes INVALID_CART_PRICING
```
    The cart and all of its items must have finalized pricing before the checkout can be processed.
  - STALE_CART_PRICING_HIGHER
```
public static final DefaultCheckoutFailureTypes 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
```
public static final DefaultCheckoutFailureTypes STALE_CART_PRICING_LOWER
```
    The cart pricing is out of date and the latest prices are lower than they previously were.
  - INVALID_PAYMENT_CONFIG
```
public static final DefaultCheckoutFailureTypes 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
```
public static final DefaultCheckoutFailureTypes 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
```
public static final DefaultCheckoutFailureTypes 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
```
public static final DefaultCheckoutFailureTypes FAILED_INVENTORY_CHECK
```
    An inventory check against the cart's items failed. Therefore, checkout cannot be completed.
  - PAYMENT_REQUIRES_3DS_VERIFICATION
```
public static final DefaultCheckoutFailureTypes 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_CONFIRMATION
```
public static final DefaultCheckoutFailureTypes FAILED_PAYMENT_CONFIRMATION
```
    The confirmation of the cart's payment(s) failed. Therefore, checkout cannot be completed.
- Method Detail
  - values
```
public static DefaultCheckoutFailureTypes[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (DefaultCheckoutFailureTypes c : DefaultCheckoutFailureTypes.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static DefaultCheckoutFailureTypes valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - isInternalError
```
public static boolean isInternalError(String failureType)
```
  - isInvalidCartStatusFailure
```
public static boolean isInvalidCartStatusFailure(String failureType)
```
  - isInvalidCartItemConfigFailure
```
public static boolean isInvalidCartItemConfigFailure(String failureType)
```
  - isInvalidCartFulfillmentConfigFailure
```
public static boolean isInvalidCartFulfillmentConfigFailure(String failureType)
```
  - isInvalidCartFulfillmentMissingFailure
```
public static boolean isInvalidCartFulfillmentMissingFailure(String failureType)
```
  - isInvalidCartPricingFailure
```
public static boolean isInvalidCartPricingFailure(String failureType)
```
  - isInvalidPaymentConfigFailure
```
public static boolean isInvalidPaymentConfigFailure(String failureType)
```
  - isInvalidOfferOrOfferCodeUsageFailure
```
public static boolean isInvalidOfferOrOfferCodeUsageFailure(String failureType)
```
  - isInvalidCampaignCodeUsageFailure
```
public static boolean isInvalidCampaignCodeUsageFailure(String failureType)
```
  - isPaymentConfirmationFailure
```
public static boolean isPaymentConfirmationFailure(String failureType)
```
  - getMessagePath
```
public String getMessagePath()
```
    Specified by:
    
    getMessagePath in interface CheckoutFailureType

Enum DefaultCheckoutFailureTypes

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface com.broadleafcommerce.cartoperation.domain.CheckoutFailureType

Enum Constant Detail

INTERNAL_ERROR

DUPLICATE_REQUEST_ID

INVALID_CART_STATUS

INVALID_CART_ITEM_CONFIG

INVALID_CART_FULFILLMENT_CONFIG

INVALID_CART_FULFILLMENT_MISSING

INVALID_CART_PRICING

STALE_CART_PRICING_HIGHER

STALE_CART_PRICING_LOWER

INVALID_PAYMENT_CONFIG

INVALID_OFFER_OR_OFFER_CODE_USAGE

INVALID_CAMPAIGN_CODE_USAGE

FAILED_INVENTORY_CHECK

PAYMENT_REQUIRES_3DS_VERIFICATION

FAILED_PAYMENT_CONFIRMATION

Method Detail

values

valueOf

isInternalError

isInvalidCartStatusFailure

isInvalidCartItemConfigFailure

isInvalidCartFulfillmentConfigFailure

isInvalidCartFulfillmentMissingFailure

isInvalidCartPricingFailure

isInvalidPaymentConfigFailure

isInvalidOfferOrOfferCodeUsageFailure

isInvalidCampaignCodeUsageFailure

isPaymentConfirmationFailure

getMessagePath