atg.commerce.order

Class ConfigurableCommerceItem

java.lang.Object

atg.commerce.order.CommerceIdentifierImpl

atg.commerce.order.CommerceItemImpl

atg.commerce.order.ConfigurableCommerceItem

All Implemented Interfaces:

ChangedProperties, CommerceIdentifier, CommerceItem, CommerceItemContainer, CostCenterRelationshipContainer, PaymentGroupRelationshipContainer, ShippingGroupRelationshipContainer, java.io.Serializable, java.util.Observer

public class ConfigurableCommerceItem
extends CommerceItemImpl
implements CommerceItemContainer

An implementation of a class which represents a ConfigurableCommerceItem. This class represents a Commerce item which is the base sku of a "packaged" product such as a computer which can be configured as a user chooses.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Fields inherited from class atg.commerce.order.CommerceItemImpl

mAuxiliaryData

Constructor Summary

Constructors

Constructor and Description
ConfigurableCommerceItem()

Method Summary

Modifier and Type	Method and Description
void	addCommerceItem(CommerceItem pCommerceItem) Add the CommerceItem to the container.
void	addCommerceItem(CommerceItem pCommerceItem, int pIndex) Add the CommerceItem to the container at the given index.
CommerceItem	getCommerceItem(java.lang.String pCommerceItemId) Returns the CommerceItem whose id is pCommerceItemId.
CommerceItem	getCommerceItem(java.lang.String pCommerceItemId, boolean pSearchChildItems) Returns the commerce item whose id is pCommerceItemId.
int	getCommerceItemCount() Returns the number of CommerceItems in the container.
java.util.List	getCommerceItems() Returns a List of CommerceItems
java.util.List	getCommerceItemsByCatalogRefId(java.lang.String pCatalogRefId) Returns a List of CommerceItems whose catalogRefId is pCatalogRefId.
java.lang.String	getConfiguratorId() Returns property configuratorId
java.lang.Boolean	getConfigured() Returns property configured
java.lang.String	getNotes() Returns property notes
java.lang.String	getReconfigurationData() Returns property reconfigurationData
long	getTotalCommerceItemCount() Returns the number of individual CommerceItems in the container.
double	getTotalCommerceItemCountWithFraction() Returns the total count of all commerce item quantities in the container.
void	removeAllCommerceItems() Removes all the CommerceItems
CommerceItem	removeCommerceItem(java.lang.String pCommerceItemId) Removes a CommerceItem whose id is passed in.
void	setConfiguratorId(java.lang.String pConfiguratorId) Sets property configuratorId
void	setConfigured(java.lang.Boolean pConfigured) Sets property configured
void	setNotes(java.lang.String pNotes) Sets property notes
void	setReconfigurationData(java.lang.String pReconfigurationData) Sets property reconfigurationData
void	setRepositoryItem(MutableRepositoryItem pRepositoryItem) Sets the repositoryItem

Methods inherited from class atg.commerce.order.CommerceItemImpl

addChangedProperty, addCostCenterRelationship, addCostCenterRelationship, addPaymentGroupRelationship, addPaymentGroupRelationship, addShippingGroupRelationship, addShippingGroupRelationship, clearChangedProperties, createAuxiliaryData, getAuxiliaryData, getCatalogId, getCatalogKey, getCatalogRefId, getChangedProperties, getCommerceItemClassType, getCostCenterRelationship, getCostCenterRelationshipCount, getCostCenterRelationships, getExternalId, getPaymentGroupRelationship, getPaymentGroupRelationshipCount, getPaymentGroupRelationships, getPriceInfo, getPriceInfoRepositoryItem, getProductId, getPropertyValue, getQuantity, getQuantityDerivedAsFloatingPoint, getQuantityWithFraction, getRepositoryItem, getReturnedQuantity, getReturnedQuantityDerivedAsFloatingPoint, getReturnedQuantityWithFraction, getSaveAllProperties, getShippingGroupRelationship, getShippingGroupRelationshipContainer, getShippingGroupRelationshipCount, getShippingGroupRelationships, getState, getStateAsString, getStateAsUserResource, getStateDetail, isChanged, isFractional, removeAllCostCenterRelationships, removeAllPaymentGroupRelationships, removeAllShippingGroupRelationships, removeCostCenterRelationship, removePaymentGroupRelationship, removeShippingGroupRelationship, setCatalogId, setCatalogKey, setCatalogRefId, setChanged, setCommerceItemClassType, setExternalId, setPriceInfo, setPriceInfoRepositoryItem, setProductId, setPropertyValue, setQuantity, setQuantityWithFraction, setSaveAllProperties, setState, setStateAsString, setStateDetail, toString, update

Methods inherited from class atg.commerce.order.CommerceIdentifierImpl

getId, setId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface atg.commerce.order.CommerceIdentifier

getId

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Constructor Detail

ConfigurableCommerceItem

public ConfigurableCommerceItem()

Method Detail

getNotes

public java.lang.String getNotes()

Returns property notes

Returns:

returns property notes

setNotes

public void setNotes(java.lang.String pNotes)

Sets property notes

Parameters:

pNotes - the value to set for property notes

getReconfigurationData

public java.lang.String getReconfigurationData()

Returns property reconfigurationData

Returns:

returns property reconfigurationData

setReconfigurationData

public void setReconfigurationData(java.lang.String pReconfigurationData)

Sets property reconfigurationData

Parameters:

pReconfigurationData - the value to set for property reconfigurationData

getConfiguratorId

public java.lang.String getConfiguratorId()

Returns property configuratorId

Returns:

returns property configuratorId

setConfiguratorId

public void setConfiguratorId(java.lang.String pConfiguratorId)

Sets property configuratorId

Parameters:

pConfiguratorId - the value to set for property configuratorId

getConfigured

public java.lang.Boolean getConfigured()

Returns property configured

Returns:

returns property configured

setConfigured

public void setConfigured(java.lang.Boolean pConfigured)

Sets property configured

Parameters:

pConfigured - the value to set for property configured

getCommerceItems

public java.util.List getCommerceItems()

Returns a List of CommerceItems

Specified by:

getCommerceItems in interface CommerceItemContainer

addCommerceItem

public void addCommerceItem(CommerceItem pCommerceItem)
                     throws DuplicateCommerceItemException,
                            InvalidParameterException

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

Specified by:

addCommerceItem in interface CommerceItemContainer

Throws:

DuplicateCommerceItemException

InvalidParameterException

addCommerceItem

public void addCommerceItem(CommerceItem pCommerceItem,
                            int pIndex)
                     throws DuplicateCommerceItemException,
                            InvalidParameterException

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

Specified by:

addCommerceItem in interface CommerceItemContainer

Throws:

DuplicateCommerceItemException

InvalidParameterException

removeCommerceItem

public CommerceItem removeCommerceItem(java.lang.String pCommerceItemId)
                                throws CommerceItemNotFoundException,
                                       InvalidParameterException

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

Specified by:

removeCommerceItem in interface CommerceItemContainer

Throws:

CommerceItemNotFoundException

InvalidParameterException

removeAllCommerceItems

public void removeAllCommerceItems()

Removes all the CommerceItems

Specified by:

removeAllCommerceItems in interface CommerceItemContainer

getCommerceItem

public CommerceItem getCommerceItem(java.lang.String pCommerceItemId)
                             throws CommerceItemNotFoundException,
                                    InvalidParameterException

Returns the CommerceItem whose id is pCommerceItemId. If theCommerceItem with the corresponding id is not in the container then a RelationshipNotFoundException is thrown.

Specified by:

getCommerceItem in interface CommerceItemContainer

Throws:

CommerceItemNotFoundException

InvalidParameterException

getCommerceItem

public CommerceItem getCommerceItem(java.lang.String pCommerceItemId,
                                    boolean pSearchChildItems)
                             throws CommerceItemNotFoundException,
                                    InvalidParameterException

Returns the commerce item whose id is pCommerceItemId. If pSearchChildItems is true, any commerce items that are also CommerceItemContainers will be searched recursively. CommerceItemNotFoundException is thrown if pSearchChildItems is false and a commerce item with the specified id does not exist in this container or if pSearchChildItems is true and a commerce item with the specified id does not exist anywhere in the tree of nested containers.

Specified by:

getCommerceItem in interface CommerceItemContainer

Throws:

CommerceItemNotFoundException

InvalidParameterException

getCommerceItemsByCatalogRefId

public java.util.List getCommerceItemsByCatalogRefId(java.lang.String pCatalogRefId)
                                              throws CommerceItemNotFoundException,
                                                     InvalidParameterException

Returns a List of CommerceItems whose catalogRefId is pCatalogRefId. If a CommerceItem with the corresponding catalogRefId is not in the container then a CommerceItemNotFoundException is thrown.

Specified by:

getCommerceItemsByCatalogRefId in interface CommerceItemContainer

Throws:

CommerceItemNotFoundException

InvalidParameterException

getCommerceItemCount

public int getCommerceItemCount()

Returns the number of CommerceItems in the container.

Specified by:

getCommerceItemCount in interface CommerceItemContainer

getTotalCommerceItemCount

public long getTotalCommerceItemCount()

Returns the number of individual CommerceItems in the container. This means the total of all the quantities in each CommerceItem.

Specified by:

getTotalCommerceItemCount in interface CommerceItemContainer

setRepositoryItem

public void setRepositoryItem(MutableRepositoryItem pRepositoryItem)

Sets the repositoryItem

Specified by:

setRepositoryItem in interface ChangedProperties

Overrides:

setRepositoryItem in class CommerceItemImpl

getTotalCommerceItemCountWithFraction

public double getTotalCommerceItemCountWithFraction()

Returns the total count of all commerce item quantities in the container. Each commerce item's quantity is retrieved by getting the first value > 0 from commerceItem methods getQuantityWithFraction(), getQuantity(), in that order.

Specified by:

getTotalCommerceItemCountWithFraction in interface CommerceItemContainer

Returns:

a double value.