atg.b2bcommerce.order
Interface B2BCommerceItemRelationshipContainer

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

CostCenter

All Known Implementing Classes:

B2BCommerceItemRelationshipContainerImpl, CostCenterImpl

public interface B2BCommerceItemRelationshipContainer
extends java.io.Serializable

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

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Method Summary

void	addCommerceItemRelationship(B2BCommerceItemRelationship pCommerceItemRelationship) Add the CommerceItemRelationship to the container.
void	addCommerceItemRelationship(B2BCommerceItemRelationship pCommerceItemRelationship, int pIndex) Add the CommerceItemRelationship to the container at the given index.
B2BCommerceItemRelationship	getCommerceItemRelationship(java.lang.String pCommerceItemRelationshipId) Returns the CommerceItemRelationship whose id is pCommerceItemRelationshipId.
int	getCommerceItemRelationshipCount() Returns the number of CommerceItemRelationships in the container.
java.util.List	getCommerceItemRelationships() Returns a List of CommerceItemRelationships
void	removeAllCommerceItemRelationships() Removes all the CommerceItemRelationships in the container.
B2BCommerceItemRelationship	removeCommerceItemRelationship(java.lang.String pCommerceItemRelationshipId) Removes a CommerceItemRelationship 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

getCommerceItemRelationships

java.util.List getCommerceItemRelationships()

Returns a List of CommerceItemRelationships

addCommerceItemRelationship

void addCommerceItemRelationship(B2BCommerceItemRelationship pCommerceItemRelationship)
                                 throws DuplicateRelationshipException,
                                        InvalidParameterException

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

Throws:

DuplicateRelationshipException

InvalidParameterException

addCommerceItemRelationship

void addCommerceItemRelationship(B2BCommerceItemRelationship pCommerceItemRelationship,
                                 int pIndex)
                                 throws DuplicateRelationshipException,
                                        InvalidParameterException

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

Throws:

DuplicateRelationshipException

InvalidParameterException

removeCommerceItemRelationship

B2BCommerceItemRelationship removeCommerceItemRelationship(java.lang.String pCommerceItemRelationshipId)
                                                           throws RelationshipNotFoundException,
                                                                  InvalidParameterException

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

Throws:

RelationshipNotFoundException

InvalidParameterException

removeAllCommerceItemRelationships

void removeAllCommerceItemRelationships()

Removes all the CommerceItemRelationships in the container.

getCommerceItemRelationship

B2BCommerceItemRelationship getCommerceItemRelationship(java.lang.String pCommerceItemRelationshipId)
                                                        throws RelationshipNotFoundException,
                                                               InvalidParameterException

Returns the CommerceItemRelationship whose id is pCommerceItemRelationshipId. If theCommerceItemRelationship with the corresponding id is not in the container then a RelationshipNotFoundException is thrown.

Throws:

RelationshipNotFoundException

InvalidParameterException

getCommerceItemRelationshipCount

int getCommerceItemRelationshipCount()

Returns the number of CommerceItemRelationships in the container.