Package com.broadleafcommerce.paymenttransaction.domain.enums

Enum Class DefaultTransactionManagementStateReasons

java.lang.Object
java.lang.Enum<DefaultTransactionManagementStateReasons>
com.broadleafcommerce.paymenttransaction.domain.enums.DefaultTransactionManagementStateReasons
All Implemented Interfaces:
TransactionManagementStateReason, Serializable, Comparable<DefaultTransactionManagementStateReasons>, Constable
public enum DefaultTransactionManagementStateReasons extends Enum<DefaultTransactionManagementStateReasons> implements TransactionManagementStateReason

  • Enum Constant Details

    • FAILED_CHECKOUT_TX_CLEANUP

      public static final DefaultTransactionManagementStateReasons FAILED_CHECKOUT_TX_CLEANUP
      Meant to signify that the transaction is in a reversal state because it was successful, but does not correlate to a successful checkout.

    • INDETERMINANT_RESULT_CLEANUP

      public static final DefaultTransactionManagementStateReasons INDETERMINANT_RESULT_CLEANUP
      Meant to signify that the transaction's results were initially not known (likely due to a network failure). We now understand that the transaction was successful, but needs to be reversed.

    • PAYMENT_ARCHIVAL

      public static final DefaultTransactionManagementStateReasons PAYMENT_ARCHIVAL
      Meant to signify that the transaction is in a reversal state because it was successful & is tied to an archived Payment. Therefore, the transaction will no longer contribute to a checkout, subscription, etc., and it should be reversed.

    • PAYMENT_AMOUNT_UPDATE

      public static final DefaultTransactionManagementStateReasons PAYMENT_AMOUNT_UPDATE
      Meant to signify that the transaction is in a reversal state because it was successful, but the Payment.getAmount() has since changed. Therefore, the transaction should be reversed, & a new transaction reflecting the new Payment.getAmount() should be executed in its place. Note: this is typically used for checkout interactions.

    • EXTERNAL_3DS_TRANSACTION

      public static final DefaultTransactionManagementStateReasons EXTERNAL_3DS_TRANSACTION
      Meant to signify that the transaction involving 3DS verification was executed by an interaction external to this system, usually by the gateway immediately after verification. In this case, DefaultTransactionManagementStates.REVERSAL_CANDIDATE is used to ensure that the transaction is reversed, if it is not claimed by the relevant process (e.g. checkout submission).

    • EXTERNAL_TRANSACTION

      public static final DefaultTransactionManagementStateReasons EXTERNAL_TRANSACTION
      Meant to signify that the transaction was executed by an interaction external to this system, usually by the gateway immediately after verification. In this case, DefaultTransactionManagementStates.REVERSAL_CANDIDATE is used to ensure that the transaction is reversed, if it is not claimed by the relevant process (e.g. checkout submission).

  • Method Details

    • values

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

    • isFailedCheckoutTransactionCleanup

      public static boolean isFailedCheckoutTransactionCleanup(String transactionManagementState)

    • isIndeterminantResultCleanup

      public static boolean isIndeterminantResultCleanup(String transactionManagementState)

    • isPaymentArchival

      public static boolean isPaymentArchival(String transactionManagementState)

    • isPaymentAmountUpdate

      public static boolean isPaymentAmountUpdate(String transactionManagementState)

    • isExternal3dsTransaction

      public static boolean isExternal3dsTransaction(String transactionManagementState)

    • isExternalTransaction

      public static boolean isExternalTransaction(String transactionManagementState)