atg.commerce.order

Class ShippingGroupRelationshipContainerImpl

java.lang.Object

atg.commerce.order.ShippingGroupRelationshipContainerImpl

All Implemented Interfaces:

ShippingGroupRelationshipContainer, java.io.Serializable

public class ShippingGroupRelationshipContainerImpl
extends java.lang.Object
implements ShippingGroupRelationshipContainer

A class which manages the containment of ShippingGroupRelationship objects.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Constructor Summary

Constructors

Constructor and Description
ShippingGroupRelationshipContainerImpl() Constructs a ShippingGroupRelationshipContainerImpl object.

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 the ShippingGroupRelationships
ShippingGroupRelationship	removeShippingGroupRelationship(java.lang.String pShippingGroupRelationshipId) Removes a ShippingGroupRelationship whose id is passed in.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

ShippingGroupRelationshipContainerImpl

public ShippingGroupRelationshipContainerImpl()

Constructs a ShippingGroupRelationshipContainerImpl object.

Method Detail

getShippingGroupRelationships

public java.util.List getShippingGroupRelationships()

Returns a List of ShippingGroupRelationships. Note that the returned List should not be edited directly. Doing so will result in unexpected behavior. Any editing should be done through this class.

Specified by:

getShippingGroupRelationships in interface ShippingGroupRelationshipContainer

addShippingGroupRelationship

public 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.

Specified by:

addShippingGroupRelationship in interface ShippingGroupRelationshipContainer

Throws:

DuplicateRelationshipException

InvalidParameterException

addShippingGroupRelationship

public 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.

Specified by:

addShippingGroupRelationship in interface ShippingGroupRelationshipContainer

Throws:

DuplicateRelationshipException

InvalidParameterException

removeShippingGroupRelationship

public 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.

Specified by:

removeShippingGroupRelationship in interface ShippingGroupRelationshipContainer

Throws:

RelationshipNotFoundException

InvalidParameterException

removeAllShippingGroupRelationships

public void removeAllShippingGroupRelationships()

Removes all the ShippingGroupRelationships

Specified by:

removeAllShippingGroupRelationships in interface ShippingGroupRelationshipContainer

getShippingGroupRelationship

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

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

Specified by:

getShippingGroupRelationship in interface ShippingGroupRelationshipContainer

Throws:

RelationshipNotFoundException

InvalidParameterException

getShippingGroupRelationshipCount

public int getShippingGroupRelationshipCount()

Returns the number of ShippingGroupRelationships in the container.

Specified by:

getShippingGroupRelationshipCount in interface ShippingGroupRelationshipContainer