org.broadleafcommerce.common.payment

Class PaymentGatewayType

java.lang.Object

org.broadleafcommerce.common.payment.PaymentGatewayType

All Implemented Interfaces:

Serializable, BroadleafEnumerationType

public class PaymentGatewayType
extends Object
implements Serializable, BroadleafEnumerationType

This is designed such that individual payment modules will extend this to add their own type. For instance, while this class does not explicitly have a 'Braintree' payment gateway type, the Braintree module will provide an extension to this class and add itself in the list of types. For instance:

 public class BraintreeGatewayType extends PaymentGatewayType {
     public static final BRAINTREE = new PaymentGatewayType("BRAINTREE", "Braintree");
 }
 

And then in your application context:

 {@code
 
 }
 

This is especially useful in auditing scenarios so that, at a glance, you can easily see what gateway a particular order payment was processed by.

Author:

Phillip Verheyden (phillipuniverse)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static PaymentGatewayType	PASSTHROUGH
static PaymentGatewayType	TEMPORARY

Constructor Summary

Constructors

Constructor and Description
PaymentGatewayType()
PaymentGatewayType(String type, String friendlyType)

Method Summary

Methods

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

Methods inherited from class java.lang.Object

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

Field Detail

TEMPORARY

public static final PaymentGatewayType TEMPORARY

PASSTHROUGH

public static final PaymentGatewayType PASSTHROUGH

Constructor Detail

PaymentGatewayType

public PaymentGatewayType()

PaymentGatewayType

public PaymentGatewayType(String type,
                  String friendlyType)

Method Detail

getInstance

public static PaymentGatewayType getInstance(String type)

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