atg.commerce.order

Interface ShippingGroupRelationshipContainer

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

CommerceItem, CostCenter, PaymentGroup

All Known Implementing Classes:

Cash, CommerceItemImpl, ConfigurableCommerceItem, CostCenterImpl, CreditCard, FilteredCommerceItem, GiftCertificate, InStorePayment, InvoiceRequest, PaymentGroupImpl, PricingCommerceItem, ShippingGroupRelationshipContainerImpl, StoreCredit, SubSkuCommerceItem

public interface ShippingGroupRelationshipContainer
extends java.io.Serializable

Implemented by a class that contains and manages ShippingGroupRelationship objects. This interface defines methods for getting, adding, and removing ShippingGroupRelationship 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	addShippingGroupRelationship(ShippingGroupRelationship pShippingGroupRelationship) Add the ShippingGroupRelationship to the container.
void	addShippingGroupRelationship(ShippingGroupRelationship pShippingGroupRelationship, int pIndex) Add the ShippingGroupRelationship to the container at the given index.
ShippingGroupRelationship	getShippingGroupRelationship(java.lang.String pShippingGroupRelationshipId) Returns the ShippingGroupRelationship whose id is pShippingGroupRelationshipId.
int	getShippingGroupRelationshipCount() Returns the number of ShippingGroupRelationships in the container.
java.util.List	getShippingGroupRelationships() Returns a List of ShippingGroupRelationships
void	removeAllShippingGroupRelationships() Removes all ShippingGroupRelationships in the container.
ShippingGroupRelationship	removeShippingGroupRelationship(java.lang.String pShippingGroupRelationshipId) Removes a ShippingGroupRelationship 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

getShippingGroupRelationships

java.util.List getShippingGroupRelationships()

Returns a List of ShippingGroupRelationships

addShippingGroupRelationship

void addShippingGroupRelationship(ShippingGroupRelationship pShippingGroupRelationship)
                           throws DuplicateRelationshipException,
                                  InvalidParameterException

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

Throws:

DuplicateRelationshipException

InvalidParameterException

addShippingGroupRelationship

void addShippingGroupRelationship(ShippingGroupRelationship pShippingGroupRelationship,
                                  int pIndex)
                           throws DuplicateRelationshipException,
                                  InvalidParameterException

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

Throws:

DuplicateRelationshipException

InvalidParameterException

removeShippingGroupRelationship

ShippingGroupRelationship removeShippingGroupRelationship(java.lang.String pShippingGroupRelationshipId)
                                                   throws RelationshipNotFoundException,
                                                          InvalidParameterException

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

Throws:

RelationshipNotFoundException

InvalidParameterException

removeAllShippingGroupRelationships

void removeAllShippingGroupRelationships()

Removes all ShippingGroupRelationships in the container.

getShippingGroupRelationship

ShippingGroupRelationship getShippingGroupRelationship(java.lang.String pShippingGroupRelationshipId)
                                                throws RelationshipNotFoundException,
                                                       InvalidParameterException

Returns the ShippingGroupRelationship whose id is pShippingGroupRelationshipId. If theShippingGroupRelationship with the corresponding id is not in the container then a RelationshipNotFoundException is thrown.

Throws:

RelationshipNotFoundException

InvalidParameterException

getShippingGroupRelationshipCount

int getShippingGroupRelationshipCount()

Returns the number of ShippingGroupRelationships in the container.