atg.commerce.order

Interface ShippingGroupContainer

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

Order

All Known Implementing Classes:

OrderImpl, ShippingGroupContainerImpl

public interface ShippingGroupContainer
extends java.io.Serializable

Implemented by a class that contains and manages ShippingGroup objects. This interface defines methods for getting, adding, and removing ShippingGroup 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	addShippingGroup(ShippingGroup pShippingGroup) Add the ShippingGroup to the container.
void	addShippingGroup(ShippingGroup pShippingGroup, int pIndex) Add the ShippingGroup to the container at the given index.
ShippingGroup	getShippingGroup(java.lang.String pShippingGroupId) Returns the ShippingGroup whose id is pShippingGroupId.
int	getShippingGroupCount() Returns the number of ShippingGroups in the container.
java.util.List	getShippingGroups() Returns a List of ShippingGroups
void	removeAllShippingGroups() Removes all ShippingGroups in the container.
ShippingGroup	removeShippingGroup(java.lang.String pShippingGroupId) Removes a ShippingGroup 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

getShippingGroups

java.util.List getShippingGroups()

Returns a List of ShippingGroups

addShippingGroup

void addShippingGroup(ShippingGroup pShippingGroup)
               throws DuplicateShippingGroupException,
                      InvalidParameterException

Add the ShippingGroup to the container. If the ShippingGroup was already in the container a DuplicateShippingGroupException is thrown.

Throws:

DuplicateShippingGroupException

InvalidParameterException

addShippingGroup

void addShippingGroup(ShippingGroup pShippingGroup,
                      int pIndex)
               throws DuplicateShippingGroupException,
                      InvalidParameterException

Add the ShippingGroup to the container at the given index. If the ShippingGroup was already in the container a DuplicateShippingGroupException is thrown.

Throws:

DuplicateShippingGroupException

InvalidParameterException

removeShippingGroup

ShippingGroup removeShippingGroup(java.lang.String pShippingGroupId)
                           throws ShippingGroupNotFoundException,
                                  InvalidParameterException

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

Throws:

ShippingGroupNotFoundException

InvalidParameterException

removeAllShippingGroups

void removeAllShippingGroups()

Removes all ShippingGroups in the container.

getShippingGroup

ShippingGroup getShippingGroup(java.lang.String pShippingGroupId)
                        throws ShippingGroupNotFoundException,
                               InvalidParameterException

Returns the ShippingGroup whose id is pShippingGroupId. If the ShippingGroup with the corresponding id is not in the container then a ShippingGroupNotFoundException is thrown.

Throws:

ShippingGroupNotFoundException

InvalidParameterException

getShippingGroupCount

int getShippingGroupCount()

Returns the number of ShippingGroups in the container.