atg.commerce.order

Interface PaymentGroupRelationshipContainer

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

CommerceItem, Order, ShippingGroup

All Known Implementing Classes:

CommerceItemImpl, ConfigurableCommerceItem, ElectronicShippingGroup, FilteredCommerceItem, HardgoodShippingGroup, InStorePickupShippingGroup, OrderImpl, PaymentGroupRelationshipContainerImpl, PricingCommerceItem, ShippingGroupImpl, SubSkuCommerceItem

public interface PaymentGroupRelationshipContainer
extends java.io.Serializable

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

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
void	addPaymentGroupRelationship(PaymentGroupRelationship pPaymentGroupRelationship) Add the PaymentGroupRelationship to the container.
void	addPaymentGroupRelationship(PaymentGroupRelationship pPaymentGroupRelationship, int pIndex) Add the PaymentGroupRelationship to the container at the given index.
PaymentGroupRelationship	getPaymentGroupRelationship(java.lang.String pPaymentGroupRelationshipId) Returns the PaymentGroupRelationship whose id is pPaymentGroupRelationshipId.
int	getPaymentGroupRelationshipCount() Returns the number of PaymentGroupRelationships in the container.
java.util.List	getPaymentGroupRelationships() Returns a List of PaymentGroupRelationships
void	removeAllPaymentGroupRelationships() Removes all the PaymentGroupRelationships in the container.
PaymentGroupRelationship	removePaymentGroupRelationship(java.lang.String pPaymentGroupRelationshipId) Removes a PaymentGroupRelationship 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

getPaymentGroupRelationships

java.util.List getPaymentGroupRelationships()

Returns a List of PaymentGroupRelationships

addPaymentGroupRelationship

void addPaymentGroupRelationship(PaymentGroupRelationship pPaymentGroupRelationship)
                          throws DuplicateRelationshipException,
                                 InvalidParameterException

Add the PaymentGroupRelationship to the container. If the PaymentGroupRelationship was already in the container a DuplicateRelationshipException is thrown.

Throws:

DuplicateRelationshipException

InvalidParameterException

addPaymentGroupRelationship

void addPaymentGroupRelationship(PaymentGroupRelationship pPaymentGroupRelationship,
                                 int pIndex)
                          throws DuplicateRelationshipException,
                                 InvalidParameterException

Add the PaymentGroupRelationship to the container at the given index. If the PaymentGroupRelationship was already in the container a DuplicateRelationshipException is thrown.

Throws:

DuplicateRelationshipException

InvalidParameterException

removePaymentGroupRelationship

PaymentGroupRelationship removePaymentGroupRelationship(java.lang.String pPaymentGroupRelationshipId)
                                                 throws RelationshipNotFoundException,
                                                        InvalidParameterException

Removes a PaymentGroupRelationship whose id is passed in. If the PaymentGroupRelationship is not in the container then a RelationshipNotFoundException is thrown. Otherwise a reference to the removed PaymentGroupRelationship is returned.

Throws:

RelationshipNotFoundException

InvalidParameterException

removeAllPaymentGroupRelationships

void removeAllPaymentGroupRelationships()

Removes all the PaymentGroupRelationships in the container.

getPaymentGroupRelationship

PaymentGroupRelationship getPaymentGroupRelationship(java.lang.String pPaymentGroupRelationshipId)
                                              throws RelationshipNotFoundException,
                                                     InvalidParameterException

Returns the PaymentGroupRelationship whose id is pPaymentGroupRelationshipId. If the PaymentGroupRelationship with the corresponding id is not in the container then a RelationshipNotFoundException is thrown.

Throws:

RelationshipNotFoundException

InvalidParameterException

getPaymentGroupRelationshipCount

int getPaymentGroupRelationshipCount()

Returns the number of PaymentGroupRelationships in the container.