CommerceItem (ATG Java API)

All Superinterfaces:

CommerceIdentifier, CostCenterRelationshipContainer, PaymentGroupRelationshipContainer, java.io.Serializable, ShippingGroupRelationshipContainer

All Known Implementing Classes:

CommerceItemImpl, ConfigurableCommerceItem, FilteredCommerceItem, PricingCommerceItem, SubSkuCommerceItem
```
public interface CommerceItem
extends ShippingGroupRelationshipContainer, PaymentGroupRelationshipContainer, CostCenterRelationshipContainer, CommerceIdentifier, java.io.Serializable
```
Implemented by classes which represent a CommerceItem. This interface provides all the methods to manipulate a CommerceItem object.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CLASS_VERSION
Class version string

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

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`AuxiliaryData`	`getAuxiliaryData()` returns the AuxiliaryData.
`java.lang.String`	`getCatalogId()` Returns the catalogId
`java.lang.String`	`getCatalogKey()` Returns the catalogKey
`java.lang.String`	`getCatalogRefId()` Returns the catalogRefId
`java.lang.String`	`getCommerceItemClassType()` Returns the commerceItemClassType
`java.lang.String`	`getExternalId()` Returns property externalId.
`ItemPriceInfo`	`getPriceInfo()` returns the CommerceItemPriceInfo object.
`long`	`getQuantity()` returns the number of CommerceItems which this CommerceItem object represents.
`double`	`getQuantityDerivedAsFloatingPoint()` This method will return a derived quantity value which this CommerceItem object represents.
`double`	`getQuantityWithFraction()` Returns the fractional number of CommerceItems which this CommerceItem object represents.
`long`	`getReturnedQuantity()` Returns the returnedQuantity
`double`	`getReturnedQuantityDerivedAsFloatingPoint()` This method will return a derived returned quantity value which this CommerceItem object represents.
`double`	`getReturnedQuantityWithFraction()` Returns the number of CommerceItems to be returned.
`int`	`getState()` Returns the state
`default java.lang.String`	`getStateAsString()` Returns an UNSET state for a class that has no custom implementation.
`java.lang.String`	`getStateDetail()` Returns the stateDetail
`boolean`	`isFractional()` This returns `true` if fractional quantity is set (i.e.
`void`	`setCatalogId(java.lang.String pCatalogId)` Sets the catalogId
`void`	`setCatalogKey(java.lang.String pCatalogKey)` Sets the catalogKey
`void`	`setCatalogRefId(java.lang.String pCatalogRefId)` Sets the catalogRefId
`void`	`setCommerceItemClassType(java.lang.String pCommerceItemClassType)` Sets the commerceItemClassType
`void`	`setExternalId(java.lang.String pExternalId)` Sets property externalId.
`void`	`setPriceInfo(ItemPriceInfo pPriceInfo)` sets the ItemPriceInfo object.
`void`	`setQuantity(long pQuantity)` sets the number of CommerceItems which this CommerceItem object represents.
`void`	`setQuantityWithFraction(double pQuantityWithFraction)` Sets the fractional number of CommerceItems which this CommerceItem object represents.
`void`	`setState(int pState)` Sets the state
`void`	`setStateDetail(java.lang.String pStateDetail)` Sets the stateDetail

Methods inherited from interface atg.commerce.order.ShippingGroupRelationshipContainer
addShippingGroupRelationship, addShippingGroupRelationship, getShippingGroupRelationship, getShippingGroupRelationshipCount, getShippingGroupRelationships, removeAllShippingGroupRelationships, removeShippingGroupRelationship

Methods inherited from interface atg.commerce.order.PaymentGroupRelationshipContainer
addPaymentGroupRelationship, addPaymentGroupRelationship, getPaymentGroupRelationship, getPaymentGroupRelationshipCount, getPaymentGroupRelationships, removeAllPaymentGroupRelationships, removePaymentGroupRelationship

Methods inherited from interface atg.commerce.order.CostCenterRelationshipContainer
addCostCenterRelationship, addCostCenterRelationship, getCostCenterRelationship, getCostCenterRelationshipCount, getCostCenterRelationships, removeAllCostCenterRelationships, removeCostCenterRelationship

Methods inherited from interface atg.commerce.order.CommerceIdentifier
getId

- Field Detail
  - CLASS_VERSION
```
static final java.lang.String CLASS_VERSION
```
    Class version string
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getCommerceItemClassType
```
java.lang.String getCommerceItemClassType()
```
    Returns the commerceItemClassType
  - setCommerceItemClassType
```
void setCommerceItemClassType(java.lang.String pCommerceItemClassType)
```
    Sets the commerceItemClassType
  - setExternalId
```
void setExternalId(java.lang.String pExternalId)
```
    Sets property externalId. The external ID of the commerce item. May be null.
  - getExternalId
```
java.lang.String getExternalId()
```
    Returns property externalId. The external ID of the commerce item. May be null.
  - getCatalogId
```
java.lang.String getCatalogId()
```
    Returns the catalogId
  - setCatalogId
```
void setCatalogId(java.lang.String pCatalogId)
```
    Sets the catalogId
  - getCatalogRefId
```
java.lang.String getCatalogRefId()
```
    Returns the catalogRefId
  - setCatalogRefId
```
void setCatalogRefId(java.lang.String pCatalogRefId)
```
    Sets the catalogRefId
  - getCatalogKey
```
java.lang.String getCatalogKey()
```
    Returns the catalogKey
  - setCatalogKey
```
void setCatalogKey(java.lang.String pCatalogKey)
```
    Sets the catalogKey
  - getQuantity
```
long getQuantity()
```
    returns the number of CommerceItems which this CommerceItem object represents.
  - setQuantity
```
void setQuantity(long pQuantity)
```
    sets the number of CommerceItems which this CommerceItem object represents.
    
    Parameters:
    
    pQuantity - the new value for the quantity
  - getQuantityWithFraction
```
double getQuantityWithFraction()
```
    Returns the fractional number of CommerceItems which this CommerceItem object represents.
    
    Returns:
    
    a double value.
  - setQuantityWithFraction
```
void setQuantityWithFraction(double pQuantityWithFraction)
```
    Sets the fractional number of CommerceItems which this CommerceItem object represents.
    
    Parameters:
    
    pQuantityWithFraction - the new value for the quantity with fraction.
  - getQuantityDerivedAsFloatingPoint
```
double getQuantityDerivedAsFloatingPoint()
```
    This method will return a derived quantity value which this CommerceItem object represents.
    The implementation of this method will decide upon the correct quantity value to return, when considering the quantity and quantityWithFraction properties.
    The method should be used where there is a need to know the quantity of an item but it is unknown to the caller as to which property (quantityWithFraction or quantity holds the value.
    
    Returns:
    
    a derived quantity of CommerceItems which this CommerceItem object represents
  - isFractional
```
boolean isFractional()
```
    This returns true if fractional quantity is set (i.e. it has the fractional value which is greater than zero) for the item for which this relationship represents, otherwise false is returned.
    
    Returns:
    
    boolean value.
  - getReturnedQuantity
```
long getReturnedQuantity()
```
    Returns the returnedQuantity
  - getReturnedQuantityWithFraction
```
double getReturnedQuantityWithFraction()
```
    Returns the number of CommerceItems to be returned.
    
    Returns:
    
    the returned quantity (with fraction) of CommerceItem.
  - getReturnedQuantityDerivedAsFloatingPoint
```
double getReturnedQuantityDerivedAsFloatingPoint()
```
    This method will return a derived returned quantity value which this CommerceItem object represents.
    The implementation of this method will decide upon the correct returned quantity value to return, when considering the returnedQuantity and returnedQuantityWithFraction properties.
    The method should be used where there is a need to know the returned quantity of an item but it is unknown to the caller as to which property (returnedQuantityWithFraction or returnedQuantity holds the value.
    
    Returns:
    
    a derived returned quantity of CommerceItems which this CommerceItem object represents
  - getState
```
int getState()
```
    Returns the state
  - setState
```
void setState(int pState)
```
    Sets the state
  - getStateDetail
```
java.lang.String getStateDetail()
```
    Returns the stateDetail
  - setStateDetail
```
void setStateDetail(java.lang.String pStateDetail)
```
    Sets the stateDetail
  - getPriceInfo
```
ItemPriceInfo getPriceInfo()
```
    returns the CommerceItemPriceInfo object.
  - setPriceInfo
```
void setPriceInfo(ItemPriceInfo pPriceInfo)
```
    sets the ItemPriceInfo object.
    
    Parameters:
    
    pPriceInfo - the PriceInfo object to set
  - getAuxiliaryData
```
AuxiliaryData getAuxiliaryData()
```
    returns the AuxiliaryData.
  - getStateAsString
```
default java.lang.String getStateAsString()
```
    Returns an UNSET state for a class that has no custom implementation.
    
    Returns:
    
    the state

Interface CommerceItem

Field Summary

Method Summary

Methods inherited from interface atg.commerce.order.ShippingGroupRelationshipContainer

Methods inherited from interface atg.commerce.order.PaymentGroupRelationshipContainer

Methods inherited from interface atg.commerce.order.CostCenterRelationshipContainer

Methods inherited from interface atg.commerce.order.CommerceIdentifier

Field Detail

CLASS_VERSION

Method Detail

getCommerceItemClassType

setCommerceItemClassType

setExternalId

getExternalId

getCatalogId

setCatalogId

getCatalogRefId

setCatalogRefId

getCatalogKey

setCatalogKey

getQuantity

setQuantity

getQuantityWithFraction

setQuantityWithFraction

getQuantityDerivedAsFloatingPoint

isFractional

getReturnedQuantity

getReturnedQuantityWithFraction

getReturnedQuantityDerivedAsFloatingPoint

getState

setState

getStateDetail

setStateDetail

getPriceInfo

setPriceInfo

getAuxiliaryData

getStateAsString