atg.commerce.payment

Interface PaymentTypeProvider

All Known Implementing Classes:

CreditCardTools, PaymentManager

public interface PaymentTypeProvider

Interface which defines functionality for classes which govern payment types

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Method Summary

Modifier and Type	Method and Description
PaymentType	getPaymentTypeForPaymentGroup(PaymentGroup pPaymentGroup) Get a payment type object for a specific payment group which has a payment amount greater than zero.
PaymentType	getPaymentTypeForString(java.lang.String pPaymentGroupIdentifier, java.lang.String pPaymentTypeString) Create a payment type object based upon a formatted string.
java.util.Set<PaymentType>	getSupportedPaymentTypes(java.lang.String pPaymentGroupIdentifier) Get payment type objects for all payment type variations associated with the payment group identifier passed in.

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

getSupportedPaymentTypes

java.util.Set<PaymentType> getSupportedPaymentTypes(java.lang.String pPaymentGroupIdentifier)
                                             throws InvalidParameterException

Get payment type objects for all payment type variations associated with the payment group identifier passed in.

Parameters:

pPaymentGroupIdentifier - An identifier for the group we're going to get payment types for.

Returns:

A set of payment types corresponding to the payment group identifier passed in.

Throws:

InvalidParameterException - if the payment group identifier passed in was deemed invalid.

getPaymentTypeForPaymentGroup

PaymentType getPaymentTypeForPaymentGroup(PaymentGroup pPaymentGroup)
                                   throws InvalidParameterException

Get a payment type object for a specific payment group which has a payment amount greater than zero.

Parameters:

pPaymentGroup - The payment group whose payment type we're interested in.

Returns:

A single payment type object representing the payment group passed in.

Throws:

InvalidParameterException - if the payment group identifier passed in was deemed invalid.

getPaymentTypeForString

PaymentType getPaymentTypeForString(java.lang.String pPaymentGroupIdentifier,
                                    java.lang.String pPaymentTypeString)
                             throws InvalidParameterException

Create a payment type object based upon a formatted string.

Parameters:

pPaymentGroupIdentifier - An identifier for the payment group which the payment type will related to.

pPaymentTypeString - The original payment string will have consisted of the group identifier followed by other info specific to that payment type. So this is the rest of the string minus the group identifier (and first delimiter). It will be up to individual providers what to do with this information, but one expected use will be that it denotes a variation of a payment group type.

Returns:

A payment type object representing the strings passed in.

Throws:

InvalidParameterException - if the payment group identifier passed in was deemed invalid.