atg.b2bcommerce.order
Interface B2BShippingGroupRelationshipContainer

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

CostCenter

All Known Implementing Classes:

B2BShippingGroupRelationshipContainerImpl, CostCenterImpl

public interface B2BShippingGroupRelationshipContainer
extends java.io.Serializable

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

Field Summary

static java.lang.String

CLASS_VERSION Class version string

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 ShippingGroupRelationships in the container.
B2BShippingGroupRelationship	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(B2BShippingGroupRelationship 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(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.

Throws:

DuplicateRelationshipException

InvalidParameterException

removeShippingGroupRelationship

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.

Throws:

RelationshipNotFoundException

InvalidParameterException

removeAllShippingGroupRelationships

void removeAllShippingGroupRelationships()

Removes all ShippingGroupRelationships in the container.

getShippingGroupRelationship

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