atg.commerce.order.purchase
Interface PaymentGroupMapContainer

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

PaymentGroupContainerService

public interface PaymentGroupMapContainer
extends java.io.Serializable

The PaymentGroupMapContainer interface is used to represent a container of a Map of payment names [key] to PaymentGroups [value].

Field Summary

static java.lang.String

CLASS_VERSION

Method Summary

void	addPaymentGroup(java.lang.String pPaymentGroupName, PaymentGroup pPaymentGroup) The addPaymentGroup method adds the supplied payment name and PaymentGroup to the Map.
java.lang.String	getDefaultPaymentGroupName() The getDefaultPaymentGroupName method retrieves the name of the default PaymentGroup.
PaymentGroup	getPaymentGroup(java.lang.String pPaymentGroupName) The getPaymentGroup method returns the PaymentGroup corresponding to the supplied payment name.
java.util.Map	getPaymentGroupMap() The getPaymentGroupMap method returns the Map of payment names to PaymentGroups.
void	removeAllPaymentGroups() The removeAllPaymentGroups method clears the Map.
void	removePaymentGroup(java.lang.String pPaymentGroupName) The removePaymentGroup method removes the PaymentGroup corresponding to the supplied payment name.
void	setDefaultPaymentGroupName(java.lang.String pDefaultPaymentGroupName) The setDefaultPaymentGroupName method marks the name of the default PaymentGroup.

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

See Also:

Constant Field Values

Method Detail

getPaymentGroupMap

java.util.Map getPaymentGroupMap()

The getPaymentGroupMap method returns the Map of payment names to PaymentGroups.

Returns:

a Map value

getPaymentGroup

PaymentGroup getPaymentGroup(java.lang.String pPaymentGroupName)

The getPaymentGroup method returns the PaymentGroup corresponding to the supplied payment name.

Parameters:

pPaymentGroupName - a String value

Returns:

a PaymentGroup value

addPaymentGroup

void addPaymentGroup(java.lang.String pPaymentGroupName,
                     PaymentGroup pPaymentGroup)

The addPaymentGroup method adds the supplied payment name and PaymentGroup to the Map.

Parameters:

pPaymentGroupName - a String value

pPaymentGroup - a PaymentGroup value

removeAllPaymentGroups

void removeAllPaymentGroups()

The removeAllPaymentGroups method clears the Map.

removePaymentGroup

void removePaymentGroup(java.lang.String pPaymentGroupName)

The removePaymentGroup method removes the PaymentGroup corresponding to the supplied payment name.

Parameters:

pPaymentGroupName - a String value

setDefaultPaymentGroupName

void setDefaultPaymentGroupName(java.lang.String pDefaultPaymentGroupName)

The setDefaultPaymentGroupName method marks the name of the default PaymentGroup.

Parameters:

pDefaultPaymentGroupName - a String value

getDefaultPaymentGroupName

java.lang.String getDefaultPaymentGroupName()

The getDefaultPaymentGroupName method retrieves the name of the default PaymentGroup.

Returns:

a String value