Package com.broadleafcommerce.cartoperation.domain.enums

Enum Class DefaultPaymentFinalizationStatus

java.lang.Object
java.lang.Enum<DefaultPaymentFinalizationStatus>
com.broadleafcommerce.cartoperation.domain.enums.DefaultPaymentFinalizationStatus
All Implemented Interfaces:
PaymentFinalizationStatus, Serializable, Comparable<DefaultPaymentFinalizationStatus>, Constable
public enum DefaultPaymentFinalizationStatus extends Enum<DefaultPaymentFinalizationStatus> implements PaymentFinalizationStatus
Describes the state of a cart's payments that required additional customer action (e.g. 3DS verification or HPP interaction) to be considered finalized.
Author:
Chris Kittrell (ckittrell)

  • Enum Constant Details

    • FINALIZED

      public static final DefaultPaymentFinalizationStatus FINALIZED
      All of the cart's payments have been finalized (i.e. all 3DS or HPP interactions have been successfully completed)

    • REQUIRES_PAYMENT_MODIFICATION

      public static final DefaultPaymentFinalizationStatus REQUIRES_PAYMENT_MODIFICATION
      One or more of the cart's payments cannot contribute to a successful checkout, & the customer must be prompted to provide one or more alternative payment methods. For example, if a payment transaction fails after successful 3DS, then that payment cannot contribute to paying for the cart. Therefore, the customer should be prompted for another form of payment.

    • REQUIRES_ADDL_EXTERNAL_INTERACTION

      public static final DefaultPaymentFinalizationStatus REQUIRES_ADDL_EXTERNAL_INTERACTION
      One or more of the cart's payments requires action from the customer. This can happen if the cart has multiple payments that require 3DS verification or a HPP interaction. The first 3DS/HPP interaction may have been successfully completed, but the customer must complete the 3DS/HPP interaction for the next payment.

    • UNKNOWN

      public static final DefaultPaymentFinalizationStatus UNKNOWN
      The payment finalization status could not be determined. This is typically the case if an unexpected exception was encountered.

  • Method Details

    • values

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

    • isFinalized

      public static boolean isFinalized(String paymentFinalizationStatus)

    • isRequiresPaymentModification

      public static boolean isRequiresPaymentModification(String paymentFinalizationStatus)

    • isRequiresAddlExternalInteraction

      public static boolean isRequiresAddlExternalInteraction(String paymentFinalizationStatus)

    • isUnknown

      public static boolean isUnknown(String paymentFinalizationStatus)