atg.commerce.pricing.result

Class ItemPrice

java.lang.Object

atg.commerce.pricing.result.ItemPrice

public class ItemPrice
extends java.lang.Object

Contains the following information about the price of a CommerceItem:

• commerceItemId, the ID of the item
• skuId, the catalog sku ID
• productid, the product ID
• quantity, the number to be priced
• amount, the total price of the items
• discounted, boolean indicating if the item was discounted
• listPrice is the base price, before any modifications. (unitPrice)
• rawTotalPrice is the base price for the item, before any modifications. That is quantity * listPrice.
• salePrice is the sale price before any modifications. (unitPrice)
• onSale indicates whether the price is for an item that is on sale.
• orderDiscountShare the amount of all order discounts that applied to this item
• quantityDiscounted is the quantity of the CommerceItem that was discounted in any way.
• quantityAsQualifier is the quantity of the CommerceItem that acted as a qualifier to any discount.
• priceListId, the ID of the priceList used to calculate the price
• adjustments, an array of the discounts applied to the items
• currentPriceDetails, an array of DetailedItemPriceInfos that constitute a breakdown of the price represented by this object. The sum of the amounts of these DetailedItemPriceInfos should always equals this object's amount.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
ItemPrice()

Method Summary

Methods

Modifier and Type	Method and Description
PriceAdjustment[]	getAdjustments() an array of all the discounts
double	getAmount() the price of all items
java.lang.String	getCommerceItemId() the item id
DetailedItemPrice[]	getCurrentPriceDetails() currentPriceDetails is an array of DetailedItemPrices that constitute a breakdown of the price represented by this object.
double	getListPrice() listPrice is the base price, before any modifications.
double	getOrderDiscountShare() The amount from all order discounts that apply to this item (and effect the taxable amount)
java.lang.String	getPriceListId() The priceListId used to calculate this order price
java.lang.String	getProductId() the catalog product id
long	getQuantity() the number of items
long	getQuantityAsQualifier() quantityAsQualifier is the quantity of the CommerceItem that acted as a qualifier to any discount.
long	getQuantityDiscounted() quantityDiscounted is the quantity of the CommerceItem that was discounted in any way.
double	getRawTotalPrice() rawTotalPrice is the original amount of the item before any discounts or sales
double	getSalePrice() salePrice is the sale price before any modifications It is a unit price.
java.lang.String	getSkuId() the catalog sku id
boolean	isDiscounted() boolean indicating if any of the items were discounted
boolean	isOnSale() boolean indicating if the item is on sale
void	setAdjustments(PriceAdjustment[] pAdjustments) an array of all the discounts
void	setAmount(double pAmount) the price of all items
void	setCommerceItemId(java.lang.String pCommerceItemId) the item id
void	setCurrentPriceDetails(DetailedItemPrice[] pCurrentPriceDetails)
void	setDiscounted(boolean pDiscounted) boolean indicating if any of the items were discounted
void	setListPrice(double pListPrice)
void	setOnSale(boolean pOnSale) boolean indicating if the item is on sale
void	setOrderDiscountShare(double pOrderDiscountShare)
void	setPriceListId(java.lang.String pPriceListId)
void	setProductId(java.lang.String pProductId) the catalog product id
void	setQuantity(long pQuantity) the number of items
void	setQuantityAsQualifier(long pQuantityAsQualifier)
void	setQuantityDiscounted(long pQuantityDiscounted)
void	setRawTotalPrice(double pRawTotalPrice)
void	setSalePrice(double pSalePrice)
void	setSkuId(java.lang.String pSkuId) the catalog sku id
java.lang.String	toString() Returns a string form of this price information

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

ItemPrice

public ItemPrice()

Method Detail

setCommerceItemId

public void setCommerceItemId(java.lang.String pCommerceItemId)

the item id

Parameters:

pCommerceItemId - new value to set

getCommerceItemId

public java.lang.String getCommerceItemId()

the item id

Returns:

property CommerceItemId

setSkuId

public void setSkuId(java.lang.String pSkuId)

the catalog sku id

Parameters:

pSkuId - new value to set

getSkuId

public java.lang.String getSkuId()

the catalog sku id

Returns:

property SkuId

setProductId

public void setProductId(java.lang.String pProductId)

the catalog product id

Parameters:

pProductId - new value to set

getProductId

public java.lang.String getProductId()

the catalog product id

Returns:

property ProductId

setQuantity

public void setQuantity(long pQuantity)

the number of items

Parameters:

pQuantity - new value to set

getQuantity

public long getQuantity()

the number of items

Returns:

property Quantity

setAmount

public void setAmount(double pAmount)

the price of all items

Parameters:

pAmount - new value to set

getAmount

public double getAmount()

the price of all items

Returns:

property Amount

setDiscounted

public void setDiscounted(boolean pDiscounted)

boolean indicating if any of the items were discounted

Parameters:

pDiscounted - new value to set

isDiscounted

public boolean isDiscounted()

boolean indicating if any of the items were discounted

Returns:

property Discounted

setListPrice

public void setListPrice(double pListPrice)

getListPrice

public double getListPrice()

listPrice is the base price, before any modifications. It is a unit price.

Returns:

The list price

setRawTotalPrice

public void setRawTotalPrice(double pRawTotalPrice)

getRawTotalPrice

public double getRawTotalPrice()

rawTotalPrice is the original amount of the item before any discounts or sales

Returns:

The raw total price

setOnSale

public void setOnSale(boolean pOnSale)

boolean indicating if the item is on sale

Parameters:

pOnSale - new value to set

isOnSale

public boolean isOnSale()

boolean indicating if the item is on sale

Returns:

property OnSale

setSalePrice

public void setSalePrice(double pSalePrice)

getSalePrice

public double getSalePrice()

salePrice is the sale price before any modifications It is a unit price.

Returns:

The sale price

setOrderDiscountShare

public void setOrderDiscountShare(double pOrderDiscountShare)

getOrderDiscountShare

public double getOrderDiscountShare()

The amount from all order discounts that apply to this item (and effect the taxable amount)

Returns:

This items share of all order discounts

setQuantityDiscounted

public void setQuantityDiscounted(long pQuantityDiscounted)

getQuantityDiscounted

public long getQuantityDiscounted()

quantityDiscounted is the quantity of the CommerceItem that was discounted in any way.

Returns:

The quantity that was discounted

setQuantityAsQualifier

public void setQuantityAsQualifier(long pQuantityAsQualifier)

getQuantityAsQualifier

public long getQuantityAsQualifier()

quantityAsQualifier is the quantity of the CommerceItem that acted as a qualifier to any discount.

Returns:

The quantity that acted as a qualifier

setPriceListId

public void setPriceListId(java.lang.String pPriceListId)

getPriceListId

public java.lang.String getPriceListId()

The priceListId used to calculate this order price

Returns:

The priceListId

setAdjustments

public void setAdjustments(PriceAdjustment[] pAdjustments)

an array of all the discounts

Parameters:

pAdjustments - new value to set

getAdjustments

public PriceAdjustment[] getAdjustments()

an array of all the discounts

Returns:

property Adjustments

setCurrentPriceDetails

public void setCurrentPriceDetails(DetailedItemPrice[] pCurrentPriceDetails)

getCurrentPriceDetails

public DetailedItemPrice[] getCurrentPriceDetails()

currentPriceDetails is an array of DetailedItemPrices that constitute a breakdown of the price represented by this object. The sum of the amounts of these DetailedItemPrices should always equals this object's amount.

Returns:

CurrentPriceDetails

toString

public java.lang.String toString()

Returns a string form of this price information

Overrides:

toString in class java.lang.Object