Package org.broadleafcommerce.core.payment.service.type

Class OrderPaymentStatus

java.lang.Object
org.broadleafcommerce.core.payment.service.type.OrderPaymentStatus
All Implemented Interfaces:
Serializable, org.broadleafcommerce.common.BroadleafEnumerationType
public class OrderPaymentStatus extends Object implements Serializable, org.broadleafcommerce.common.BroadleafEnumerationType
Used to determine the status of an OrderPayment which is calculated based on the state of its containing PaymentTransactions
Author:
Elbert Bautista (elbertbautista)
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final OrderPaymentStatus
    AUTHORIZED
    This is equivalent to having a successful PaymentTransactionType.AUTHORIZE transaction on the payment, but there are no transactions indicating that payment has been captured.
    static final OrderPaymentStatus
    COMPLETE
    This represents a completed state for this order payment wherein no more action can be performed on the original transaction.
    static final OrderPaymentStatus
    FULLY_CAPTURED
    This is equivalent to having a successful PaymentTransactionType.AUTHORIZE_AND_CAPTURE transaction on the payment OR all the partial PaymentTransactionType.CAPTURE transaction amounts equal the original order payment transaction, but there are no transactions indicating that payment has had any refunds issued against it.
    static final OrderPaymentStatus
    PARTIALLY_COMPLETE
    This is equivalent to having a successful PaymentTransactionType.AUTHORIZE_AND_CAPTURE OR one or more PaymentTransactionType.CAPTURE transactions which may have zero or more refund transactions issued against it.
    static final OrderPaymentStatus
    PENDING
    This represents the state where there is a PaymentTransactionType.PENDING transaction on the payment, but there is not yet a completed PaymentTransactionType.AUTHORIZE or PaymentTransactionType.AUTHORIZE_AND_CAPTURE transaction.
    static final OrderPaymentStatus
    UNCONFIRMED
    This represents the state where there is only a PaymentTransactionType.UNCONFIRMED transaction on the payment.
    static final OrderPaymentStatus
    UNDETERMINED
    This is the default status for an Order Payment and is meant to encompass a state not represented by the other payment statuses.

  • Constructor Summary

    Constructors
    Constructor
    Description
    OrderPaymentStatus()
     
    OrderPaymentStatus(String type, String friendlyType)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    String
    getFriendlyType()
     
    static OrderPaymentStatus
    getInstance(String type)
     
    String
    getType()
     
    int
    hashCode()
     
    protected void
    setType(String type)
     

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • UNDETERMINED

      public static final OrderPaymentStatus UNDETERMINED
      This is the default status for an Order Payment and is meant to encompass a state not represented by the other payment statuses.

    • UNCONFIRMED

      public static final OrderPaymentStatus UNCONFIRMED
      This represents the state where there is only a PaymentTransactionType.UNCONFIRMED transaction on the payment.

    • PENDING

      public static final OrderPaymentStatus PENDING
      This represents the state where there is a PaymentTransactionType.PENDING transaction on the payment, but there is not yet a completed PaymentTransactionType.AUTHORIZE or PaymentTransactionType.AUTHORIZE_AND_CAPTURE transaction.

    • AUTHORIZED

      public static final OrderPaymentStatus AUTHORIZED
      This is equivalent to having a successful PaymentTransactionType.AUTHORIZE transaction on the payment, but there are no transactions indicating that payment has been captured.

    • FULLY_CAPTURED

      public static final OrderPaymentStatus FULLY_CAPTURED
      This is equivalent to having a successful PaymentTransactionType.AUTHORIZE_AND_CAPTURE transaction on the payment OR all the partial PaymentTransactionType.CAPTURE transaction amounts equal the original order payment transaction, but there are no transactions indicating that payment has had any refunds issued against it.

    • PARTIALLY_COMPLETE

      public static final OrderPaymentStatus PARTIALLY_COMPLETE
      This is equivalent to having a successful PaymentTransactionType.AUTHORIZE_AND_CAPTURE OR one or more PaymentTransactionType.CAPTURE transactions which may have zero or more refund transactions issued against it.

    • COMPLETE

      public static final OrderPaymentStatus COMPLETE
      This represents a completed state for this order payment wherein no more action can be performed on the original transaction. Specifically, if the transaction log contains a successful PaymentTransactionType.REVERSE_AUTH, PaymentTransactionType.VOID, PaymentTransactionType.DETACHED_CREDIT or the total transaction amount is equal to all the refund transactions.

  • Constructor Details

    • OrderPaymentStatus

      public OrderPaymentStatus()

    • OrderPaymentStatus

      public OrderPaymentStatus(String type, String friendlyType)

  • Method Details

    • getInstance

      public static OrderPaymentStatus getInstance(String type)

    • getType

      public String getType()
      Specified by:
      getType in interface org.broadleafcommerce.common.BroadleafEnumerationType

    • setType

      protected void setType(String type)

    • getFriendlyType

      public String getFriendlyType()
      Specified by:
      getFriendlyType in interface org.broadleafcommerce.common.BroadleafEnumerationType

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object