AddCommerceItemInfo (ATG Java API)

java.lang.Object
- atg.commerce.order.purchase.AddCommerceItemInfo

```
public class AddCommerceItemInfo
extends java.lang.Object
```
This class holds values that describe a commerce item before it is added to an order. Instances of this class are used as elements in the CartModifierFormHandler.items array, which is used by the form handler's methods for adding items to an order.

See Also:

CartModifierFormHandler

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CLASS_VERSION` Class version string
`protected java.lang.String`	`mCatalogRefId`
`protected java.lang.String`	`mCommerceItemType`
`protected java.lang.String`	`mGiftlistId`
`protected java.lang.String`	`mGiftlistItemId`
`protected java.lang.String`	`mLocationId`
`protected java.lang.String`	`mProductId`
`protected long`	`mQuantity`
`protected double`	`mQuantityWithFraction`
`protected java.lang.String`	`mShippingGroupType`
`protected java.lang.String`	`mSiteId`

Constructor Summary

Constructors
Constructor and Description

AddCommerceItemInfo()

Constructors
Constructor and Description
`AddCommerceItemInfo()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getCatalogRefId()` Returns the catalog reference ID (SKU) to use for a new commerce item
`java.lang.String`	`getCommerceItemType()` Returns the commerce item type to use for a new item
`java.lang.String`	`getGiftlistId()` Returns the giftlist ID associated with a new commerce item
`java.lang.String`	`getGiftlistItemId()` Returns the giftlist item ID associated with a new commerce item
`java.lang.String`	`getLocationId()`
`java.lang.String`	`getProductId()` Returns the product ID to use for a new commerce item
`long`	`getQuantity()` Returns the quantity to add for a new commerce item
`double`	`getQuantityDerivedAsFloatingPoint()` This method will return a derived quantity value to add for a new commerce item.
`double`	`getQuantityWithFraction()` Returns the quantity with fraction to add for a new commerce item
`java.lang.String`	`getShippingGroupType()`
`java.lang.String`	`getSiteId()` Returns the site ID to use for a new commerce item
`java.util.Dictionary`	`getValue()` Returns a `Dictionary` of property values associated with a new commerce item
`void`	`setCatalogRefId(java.lang.String pCatalogRefId)` Sets the catalog reference ID (SKU) to use for a new commerce item
`void`	`setCommerceItemType(java.lang.String pCommerceItemType)` Sets the commerce item type to use for a new item
`void`	`setGiftlistId(java.lang.String pGiftlistId)` Sets the giftlist ID associated with a new commerce item
`void`	`setGiftlistItemId(java.lang.String pGiftlistItemId)` Sets the giftlist item ID associated with a new commerce item
`void`	`setLocationId(java.lang.String pLocationId)`
`void`	`setProductId(java.lang.String pProductId)` Sets the product ID to use for a new commerce item
`void`	`setQuantity(long pQuantity)` Sets the quantity to add for a new commerce item
`void`	`setQuantityWithFraction(double pQuantityWithFraction)` Sets the quantity with fraction to add for a new commerce item
`void`	`setShippingGroupType(java.lang.String pShippingGroupType)` Sets the shipping group type to use for a new item
`void`	`setSiteId(java.lang.String pSiteId)` Sets the site ID to use for a new commerce item

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CLASS_VERSION
```
public static java.lang.String CLASS_VERSION
```
    Class version string
  - mCatalogRefId
```
protected java.lang.String mCatalogRefId
```
  - mProductId
```
protected java.lang.String mProductId
```
  - mSiteId
```
protected java.lang.String mSiteId
```
  - mQuantity
```
protected long mQuantity
```
  - mQuantityWithFraction
```
protected double mQuantityWithFraction
```
  - mGiftlistId
```
protected java.lang.String mGiftlistId
```
  - mGiftlistItemId
```
protected java.lang.String mGiftlistItemId
```
  - mCommerceItemType
```
protected java.lang.String mCommerceItemType
```
  - mShippingGroupType
```
protected java.lang.String mShippingGroupType
```
  - mLocationId
```
protected java.lang.String mLocationId
```
- Constructor Detail
  - AddCommerceItemInfo
```
public AddCommerceItemInfo()
```
- Method Detail
  - setCatalogRefId
```
public void setCatalogRefId(java.lang.String pCatalogRefId)
```
    Sets the catalog reference ID (SKU) to use for a new commerce item
  - getCatalogRefId
```
public java.lang.String getCatalogRefId()
```
    Returns the catalog reference ID (SKU) to use for a new commerce item
  - setProductId
```
public void setProductId(java.lang.String pProductId)
```
    Sets the product ID to use for a new commerce item
  - getProductId
```
public java.lang.String getProductId()
```
    Returns the product ID to use for a new commerce item
  - setSiteId
```
public void setSiteId(java.lang.String pSiteId)
```
    Sets the site ID to use for a new commerce item
  - getSiteId
```
public java.lang.String getSiteId()
```
    Returns the site ID to use for a new commerce item
  - setQuantity
```
public void setQuantity(long pQuantity)
```
    Sets the quantity to add for a new commerce item
  - getQuantity
```
public long getQuantity()
```
    Returns the quantity to add for a new commerce item
  - setQuantityWithFraction
```
public void setQuantityWithFraction(double pQuantityWithFraction)
```
    Sets the quantity with fraction to add for a new commerce item
    
    Parameters:
    
    pQuantityWithFraction - represents the fractional quantity.
  - getQuantityWithFraction
```
public double getQuantityWithFraction()
```
    Returns the quantity with fraction to add for a new commerce item
    
    Returns:
    
    mQuantityWithFraction a double value.
  - getQuantityDerivedAsFloatingPoint
```
public double getQuantityDerivedAsFloatingPoint()
```
    This method will return a derived quantity value to add for a new commerce item.
    It will decide upon the correct quantity value to return, returning the first non zero value from the properties, quantityWithFraction, quantity, in that order.
    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 to add for a new commerce item
  - setGiftlistId
```
public void setGiftlistId(java.lang.String pGiftlistId)
```
    Sets the giftlist ID associated with a new commerce item
  - getGiftlistId
```
public java.lang.String getGiftlistId()
```
    Returns the giftlist ID associated with a new commerce item
  - setGiftlistItemId
```
public void setGiftlistItemId(java.lang.String pGiftlistItemId)
```
    Sets the giftlist item ID associated with a new commerce item
  - getGiftlistItemId
```
public java.lang.String getGiftlistItemId()
```
    Returns the giftlist item ID associated with a new commerce item
  - getValue
```
public java.util.Dictionary getValue()
```
    Returns a Dictionary of property values associated with a new commerce item
  - setCommerceItemType
```
public void setCommerceItemType(java.lang.String pCommerceItemType)
```
    Sets the commerce item type to use for a new item
    
    See Also:
    
    atg.commerce.order.OrderTools.commerceItemTypeClassMap
  - getCommerceItemType
```
public java.lang.String getCommerceItemType()
```
    Returns the commerce item type to use for a new item
  - setShippingGroupType
```
public void setShippingGroupType(java.lang.String pShippingGroupType)
```
    Sets the shipping group type to use for a new item
    
    Parameters:
    
    pShippingGroupType - the shipping group type to set
    
    See Also:
    
    atg.commerce.order.OrderTools.shippingTypeClassMap
  - getShippingGroupType
```
public java.lang.String getShippingGroupType()
```
    Returns:
    
    the shipping group type
  - getLocationId
```
public java.lang.String getLocationId()
```
    Returns:
    
    the locationId
  - setLocationId
```
public void setLocationId(java.lang.String pLocationId)
```
    Parameters:
    
    pLocationId - the locationId to set

Class AddCommerceItemInfo

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CLASS_VERSION

mCatalogRefId

mProductId

mSiteId

mQuantity

mQuantityWithFraction

mGiftlistId

mGiftlistItemId

mCommerceItemType

mShippingGroupType

mLocationId

Constructor Detail

AddCommerceItemInfo

Method Detail

setCatalogRefId

getCatalogRefId

setProductId

getProductId

setSiteId

getSiteId

setQuantity

getQuantity

setQuantityWithFraction

getQuantityWithFraction

getQuantityDerivedAsFloatingPoint

setGiftlistId

getGiftlistId

setGiftlistItemId

getGiftlistItemId

getValue

setCommerceItemType

getCommerceItemType

setShippingGroupType

getShippingGroupType

getLocationId

setLocationId