atg.commerce.order
Interface PaymentGroupContainer

All Superinterfaces:
java.io.Serializable
All Known Subinterfaces:
B2BOrder, Order
All Known Implementing Classes:
B2BOrderImpl, OrderImpl, PaymentGroupContainerImpl

public interface PaymentGroupContainer
extends java.io.Serializable

Implemented by a class that contains and manages PaymentGroup objects. This interface defines methods for getting, adding, and removing PaymentGroup objects.


Field Summary
static java.lang.String CLASS_VERSION
          Class version string
 
Method Summary
 void addPaymentGroup(PaymentGroup pPaymentGroup)
          Add the PaymentGroup to the container.
 void addPaymentGroup(PaymentGroup pPaymentGroup, int pIndex)
          Add the PaymentGroup to the container at the specified index.
 PaymentGroup getPaymentGroup(java.lang.String pPaymentGroupId)
          Returns the PaymentGroup whose id is pPaymentGroupId.
 int getPaymentGroupCount()
          Returns the number of PaymentGroups in the container.
 java.util.List getPaymentGroups()
          Returns a List of PaymentGroups
 void removeAllPaymentGroups()
          Removes all the PaymentGroups in the container.
 PaymentGroup removePaymentGroup(java.lang.String pPaymentGroupId)
          Removes a PaymentGroup whose id is passed in.
 

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION
Class version string

See Also:
Constant Field Values
Method Detail

getPaymentGroups

java.util.List getPaymentGroups()
Returns a List of PaymentGroups


addPaymentGroup

void addPaymentGroup(PaymentGroup pPaymentGroup)
                     throws DuplicatePaymentGroupException,
                            InvalidParameterException
Add the PaymentGroup to the container. If the PaymentGroup was already in the container a DuplicatePaymentGroupException is thrown.

Throws:
DuplicatePaymentGroupException
InvalidParameterException

addPaymentGroup

void addPaymentGroup(PaymentGroup pPaymentGroup,
                     int pIndex)
                     throws DuplicatePaymentGroupException,
                            InvalidParameterException
Add the PaymentGroup to the container at the specified index. If the PaymentGroup was already in the container a DuplicatePaymentGroupException is thrown.

Throws:
DuplicatePaymentGroupException
InvalidParameterException

removePaymentGroup

PaymentGroup removePaymentGroup(java.lang.String pPaymentGroupId)
                                throws PaymentGroupNotFoundException,
                                       InvalidParameterException
Removes a PaymentGroup whose id is passed in. If the PaymentGroup is not in the container then a PaymentGroupNotFoundException is thrown. Otherwise a reference to the removed PaymentGroup is returned.

Throws:
PaymentGroupNotFoundException
InvalidParameterException

removeAllPaymentGroups

void removeAllPaymentGroups()
Removes all the PaymentGroups in the container.


getPaymentGroup

PaymentGroup getPaymentGroup(java.lang.String pPaymentGroupId)
                             throws PaymentGroupNotFoundException,
                                    InvalidParameterException
Returns the PaymentGroup whose id is pPaymentGroupId. If the PaymentGroup with the corresponding id is not in the container then a PaymentGroupNotFoundException is thrown.

Throws:
PaymentGroupNotFoundException
InvalidParameterException

getPaymentGroupCount

int getPaymentGroupCount()
Returns the number of PaymentGroups in the container.