atg.commerce.order

Interface CostCenterContainer

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

Order

All Known Implementing Classes:

CostCenterContainerImpl, OrderImpl

public interface CostCenterContainer
extends java.io.Serializable

Implemented by a class that contains and manages CostCenter objects. This interface defines methods for getting, adding, and removing CostCenter 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	addCostCenter(CostCenter pCostCenter) Add the CostCenter to the container.
void	addCostCenter(CostCenter pCostCenter, int pIndex) Add the CostCenter to the container at the specified index.
CostCenter	getCostCenter(java.lang.String pCostCenterId) Returns the CostCenter whose id is pCostCenterId.
int	getCostCenterCount() Returns the number of CostCenters in the container.
java.util.List	getCostCenters() Returns a List of CostCenters
void	removeAllCostCenters() Removes all the CostCenters in the container.
CostCenter	removeCostCenter(java.lang.String pCostCenterId) Removes a CostCenter 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

getCostCenters

java.util.List getCostCenters()

Returns a List of CostCenters

addCostCenter

void addCostCenter(CostCenter pCostCenter)
            throws DuplicateCostCenterException,
                   InvalidParameterException

Add the CostCenter to the container. If the CostCenter was already in the container a DuplicateCostCenterException is thrown.

Throws:

DuplicateCostCenterException

InvalidParameterException

addCostCenter

void addCostCenter(CostCenter pCostCenter,
                   int pIndex)
            throws DuplicateCostCenterException,
                   InvalidParameterException

Add the CostCenter to the container at the specified index. If the CostCenter was already in the container a DuplicateCostCenterException is thrown.

Throws:

DuplicateCostCenterException

InvalidParameterException

removeCostCenter

CostCenter removeCostCenter(java.lang.String pCostCenterId)
                     throws CostCenterNotFoundException,
                            InvalidParameterException

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

Throws:

CostCenterNotFoundException

InvalidParameterException

removeAllCostCenters

void removeAllCostCenters()

Removes all the CostCenters in the container.

getCostCenter

CostCenter getCostCenter(java.lang.String pCostCenterId)
                  throws CostCenterNotFoundException,
                         InvalidParameterException

Returns the CostCenter whose id is pCostCenterId. If the CostCenter with the corresponding id is not in the container then a CostCenterNotFoundException is thrown.

Throws:

CostCenterNotFoundException

InvalidParameterException

getCostCenterCount

int getCostCenterCount()

Returns the number of CostCenters in the container.