org.broadleafcommerce.common.payment

Class PaymentType

java.lang.Object

org.broadleafcommerce.common.payment.PaymentType

All Implemented Interfaces:

Serializable, BroadleafEnumerationType

public class PaymentType
extends Object
implements Serializable, BroadleafEnumerationType

This represents types of payments that can be applied to an order. There might be multiple order payments with the same type on an order if the customer can pay with multiple cards (like 2 credit cards or 3 gift cards).

Author:

Phillip Verheyden (phillipuniverse)

See Also:

OrderPayment}, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static PaymentType	BANK_ACCOUNT
static PaymentType	CHECK
static PaymentType	COD
static PaymentType	CREDIT_CARD
static PaymentType	CUSTOMER_CREDIT
static PaymentType	CUSTOMER_PAYMENT
static PaymentType	ELECTRONIC_CHECK
static PaymentType	GIFT_CARD
static PaymentType	MONEY_ORDER
static PaymentType	PURCHASE_ORDER
static PaymentType	THIRD_PARTY_ACCOUNT Intended for modules like PayPal Express Checkout It is important to note that in this system an `UNCONFIRMED` `THIRD_PARTY_ACCOUNT` has a specific use case.
static PaymentType	WIRE

Constructor Summary

Constructors

Constructor and Description
PaymentType()
PaymentType(String type, String friendlyType)
PaymentType(String type, String friendlyType, boolean isFinalPayment)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getFriendlyType()
static PaymentType	getInstance(String type)
boolean	getIsFinalPayment()
String	getType()
int	hashCode()

Methods inherited from class java.lang.Object

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

Field Detail

GIFT_CARD

public static final PaymentType GIFT_CARD

CREDIT_CARD

public static final PaymentType CREDIT_CARD

BANK_ACCOUNT

public static final PaymentType BANK_ACCOUNT

CHECK

public static final PaymentType CHECK

ELECTRONIC_CHECK

public static final PaymentType ELECTRONIC_CHECK

WIRE

public static final PaymentType WIRE

MONEY_ORDER

public static final PaymentType MONEY_ORDER

CUSTOMER_CREDIT

public static final PaymentType CUSTOMER_CREDIT

COD

public static final PaymentType COD

CUSTOMER_PAYMENT

public static final PaymentType CUSTOMER_PAYMENT

PURCHASE_ORDER

public static final PaymentType PURCHASE_ORDER

THIRD_PARTY_ACCOUNT

public static final PaymentType THIRD_PARTY_ACCOUNT

Intended for modules like PayPal Express Checkout It is important to note that in this system an `UNCONFIRMED` `THIRD_PARTY_ACCOUNT` has a specific use case. The Order Payment amount can be variable. That means, when you confirm that `UNCONFIRMED` transaction, you can pass in a different amount than what was sent as the initial transaction amount. see (AdjustOrderPaymentsActivity) Note that not all third party gateways support this feature described above. Make sure to the gateway does before assigning this type to your Order Payment.

Constructor Detail

PaymentType

public PaymentType()

PaymentType

public PaymentType(String type,
                   String friendlyType)

PaymentType

public PaymentType(String type,
                   String friendlyType,
                   boolean isFinalPayment)

Method Detail

getInstance

public static PaymentType getInstance(String type)

getIsFinalPayment

public boolean getIsFinalPayment()

getType

public String getType()

Specified by:

getType in interface BroadleafEnumerationType

getFriendlyType

public String getFriendlyType()

Specified by:

getFriendlyType in interface BroadleafEnumerationType

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object