atg.commerce.order

Interface CommerceItemRelationshipContainer

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

CostCenter, PaymentGroup, ShippingGroup

All Known Implementing Classes:

Cash, CommerceItemRelationshipContainerImpl, CostCenterImpl, CreditCard, ElectronicShippingGroup, GiftCertificate, HardgoodShippingGroup, InStorePayment, InStorePickupShippingGroup, InvoiceRequest, PaymentGroupImpl, ShippingGroupImpl, StoreCredit

public interface CommerceItemRelationshipContainer
extends java.io.Serializable

Implemented by a class that contains and manages CommerceItemRelationship objects. This interface defines methods for getting, adding, and removing CommerceItemRelationship 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	addCommerceItemRelationship(CommerceItemRelationship pCommerceItemRelationship) Add the CommerceItemRelationship to the container.
void	addCommerceItemRelationship(CommerceItemRelationship pCommerceItemRelationship, int pIndex) Add the CommerceItemRelationship to the container at the given index.
CommerceItemRelationship	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.
CommerceItemRelationship	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(CommerceItemRelationship 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(CommerceItemRelationship 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

CommerceItemRelationship 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

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