atg.b2bcommerce.order
Class B2BShippingGroupRelationshipContainerImpl

java.lang.Object
  atg.b2bcommerce.order.B2BShippingGroupRelationshipContainerImpl

All Implemented Interfaces:

B2BShippingGroupRelationshipContainer, java.io.Serializable

public class B2BShippingGroupRelationshipContainerImpl
extends java.lang.Object
implements B2BShippingGroupRelationshipContainer

A class which manages the containment of B2BShippingGroupRelationship objects.

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

B2BShippingGroupRelationshipContainerImpl()
Constructs a B2BShippingGroupRelationshipContainerImpl object.

Method Summary

void	addShippingGroupRelationship(B2BShippingGroupRelationship pShippingGroupRelationship) Add the ShippingGroupRelationship to the container.
void	addShippingGroupRelationship(B2BShippingGroupRelationship pShippingGroupRelationship, int pIndex) Add the ShippingGroupRelationship to the container at the given index.
B2BShippingGroupRelationship	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
B2BShippingGroupRelationship	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

B2BShippingGroupRelationshipContainerImpl

public B2BShippingGroupRelationshipContainerImpl()

Constructs a B2BShippingGroupRelationshipContainerImpl 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 B2BShippingGroupRelationshipContainer

addShippingGroupRelationship

public void addShippingGroupRelationship(B2BShippingGroupRelationship 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 B2BShippingGroupRelationshipContainer

Throws:

DuplicateRelationshipException

InvalidParameterException

addShippingGroupRelationship

public void addShippingGroupRelationship(B2BShippingGroupRelationship 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 B2BShippingGroupRelationshipContainer

Throws:

DuplicateRelationshipException

InvalidParameterException

removeShippingGroupRelationship

public B2BShippingGroupRelationship 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 B2BShippingGroupRelationshipContainer

Throws:

RelationshipNotFoundException

InvalidParameterException

removeAllShippingGroupRelationships

public void removeAllShippingGroupRelationships()

Removes all the ShippingGroupRelationships

Specified by:

removeAllShippingGroupRelationships in interface B2BShippingGroupRelationshipContainer

getShippingGroupRelationship

public B2BShippingGroupRelationship 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 B2BShippingGroupRelationshipContainer

Throws:

RelationshipNotFoundException

InvalidParameterException

getShippingGroupRelationshipCount

public int getShippingGroupRelationshipCount()

Returns the number of ShippingGroupRelationships in the container.

Specified by:

getShippingGroupRelationshipCount in interface B2BShippingGroupRelationshipContainer