atg.commerce.order

Interface CostCenterRelationshipContainer

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

CommerceItem, Order, ShippingGroup

All Known Implementing Classes:

CommerceItemImpl, ConfigurableCommerceItem, CostCenterRelationshipContainerImpl, ElectronicShippingGroup, FilteredCommerceItem, HardgoodShippingGroup, InStorePickupShippingGroup, OrderImpl, PricingCommerceItem, ShippingGroupImpl, SubSkuCommerceItem

public interface CostCenterRelationshipContainer
extends java.io.Serializable

Implemented by a class that contains and manages CostCenterRelationship objects. This interface defines methods for getting, adding, and removing CostCenterRelationship 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	addCostCenterRelationship(CostCenterRelationship pCostCenterRelationship) Add the CostCenterRelationship to the container.
void	addCostCenterRelationship(CostCenterRelationship pCostCenterRelationship, int pIndex) Add the CostCenterRelationship to the container at the given index.
CostCenterRelationship	getCostCenterRelationship(java.lang.String pCostCenterRelationshipId) Returns the CostCenterRelationship whose id is pCostCenterRelationshipId.
int	getCostCenterRelationshipCount() Returns the number of CostCenterRelationships in the container.
java.util.List	getCostCenterRelationships() Returns a List of CostCenterRelationships
void	removeAllCostCenterRelationships() Removes all the CostCenterRelationships in the container.
CostCenterRelationship	removeCostCenterRelationship(java.lang.String pCostCenterRelationshipId) Removes a CostCenterRelationship 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

getCostCenterRelationships

java.util.List getCostCenterRelationships()

Returns a List of CostCenterRelationships

addCostCenterRelationship

void addCostCenterRelationship(CostCenterRelationship pCostCenterRelationship)
                        throws DuplicateRelationshipException,
                               InvalidParameterException

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

Throws:

DuplicateRelationshipException

InvalidParameterException

addCostCenterRelationship

void addCostCenterRelationship(CostCenterRelationship pCostCenterRelationship,
                               int pIndex)
                        throws DuplicateRelationshipException,
                               InvalidParameterException

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

Throws:

DuplicateRelationshipException

InvalidParameterException

removeCostCenterRelationship

CostCenterRelationship removeCostCenterRelationship(java.lang.String pCostCenterRelationshipId)
                                             throws RelationshipNotFoundException,
                                                    InvalidParameterException

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

Throws:

RelationshipNotFoundException

InvalidParameterException

removeAllCostCenterRelationships

void removeAllCostCenterRelationships()

Removes all the CostCenterRelationships in the container.

getCostCenterRelationship

CostCenterRelationship getCostCenterRelationship(java.lang.String pCostCenterRelationshipId)
                                          throws RelationshipNotFoundException,
                                                 InvalidParameterException

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

Throws:

RelationshipNotFoundException

InvalidParameterException

getCostCenterRelationshipCount

int getCostCenterRelationshipCount()

Returns the number of CostCenterRelationships in the container.