com.ibm.commerce.price.beans

Class PriceDataBean

java.lang.Object

com.ibm.commerce.price.utils.UnitAmountDataBeanImpl

com.ibm.commerce.price.utils.MonetaryAmountDataBean

com.ibm.commerce.price.beans.FormattedMonetaryAmountDataBean

com.ibm.commerce.price.beans.PriceDataBean

All Implemented Interfaces:

com.ibm.commerce.beans.DataBean, com.ibm.commerce.beans.InputDataBean, com.ibm.commerce.beans.SmartDataBean, FormattedMonetaryAmountInputDataBean, FormattedMonetaryAmountSmartDataBean, PriceInputDataBean, PriceSmartDataBean, java.io.Serializable

public class PriceDataBean
extends FormattedMonetaryAmountDataBean
implements PriceInputDataBean, PriceSmartDataBean

This data bean represents a Price Data Bean object. When formatting prices, the data bean will be called. This bean also contains support for displaying taxes with the price. Monetary amount of the price, StoreAccessBean and language Id are prerequisite parameters that need to be set before construction.

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.ibm.commerce.beans.SmartDataBean

COPYRIGHT

Fields inherited from interface com.ibm.commerce.beans.DataBean

emptyString

Constructor Summary

Constructors

Constructor and Description
PriceDataBean(MonetaryAmount aMonetaryAmount, com.ibm.commerce.common.objects.StoreAccessBean aStoreAccessBean, java.lang.Integer aLanguageId) Price data bean constructor.
PriceDataBean(MonetaryAmount aMonetaryAmount, com.ibm.commerce.common.objects.StoreAccessBean aStoreAccessBean, java.lang.Integer aLanguageId, java.lang.Long aCatEntryId, com.ibm.commerce.command.CommandContext aCommandContext) Price data bean constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.Long	getCatEntryId() Gets the catalog entry id.
java.math.BigDecimal	getPriceVAT() Gets total of the price with VAT.
CategorizedMonetaryAmountsDataBean	getTaxes() Invokes GetDisplayTaxes command to calculate the taxes for those tax categories that are displayable at product display time.
void	setCatEntryId(java.lang.Long aCatEntryId) Sets the catalog entry id
void	setStoreId(java.lang.Integer anStoreId) sets store id (optional).

Methods inherited from class com.ibm.commerce.price.beans.FormattedMonetaryAmountDataBean

getAmount, getCommandContext, getCurrency, getRequestProperties, populate, setAmount, setCommandContext, setCurrency, setRequestProperties

Methods inherited from class com.ibm.commerce.price.utils.MonetaryAmountDataBean

getCounterValueListPrefix, getCounterValueListSeparator, getCounterValueListSuffix, getFormattedCounterValues, getPrimaryFormattedPrice, getPrimaryPrice, isShowCounterValues, setCounterValueListPrefix, setCounterValueListSeparator, setCounterValueListSuffix, setPrimaryPrice, setShowCounterValues, toString

Methods inherited from class com.ibm.commerce.price.utils.UnitAmountDataBeanImpl

getCustomizedString, getDescription, getLangId, getNumberUsage, getStoreAccessBean, getSymbol, setLangId, setNumberUsage, setStoreAccessBean

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ibm.commerce.price.beans.FormattedMonetaryAmountInputDataBean

setAmount, setCurrency

Methods inherited from interface com.ibm.commerce.price.beans.FormattedMonetaryAmountSmartDataBean

getAmount, getCurrency

Methods inherited from interface com.ibm.commerce.beans.SmartDataBean

getCommandContext, populate, setCommandContext

Methods inherited from interface com.ibm.commerce.beans.InputDataBean

getRequestProperties, setRequestProperties

Constructor Detail

PriceDataBean

public PriceDataBean(MonetaryAmount aMonetaryAmount,
                     com.ibm.commerce.common.objects.StoreAccessBean aStoreAccessBean,
                     java.lang.Integer aLanguageId)

Price data bean constructor.

Parameters:

aMonetaryAmount - monetary amount of the price.

aStoreAccessBean - store under which the formatting is to occur.

aLanguageId - language Id under which the formatting is to occur.

PriceDataBean

public PriceDataBean(MonetaryAmount aMonetaryAmount,
                     com.ibm.commerce.common.objects.StoreAccessBean aStoreAccessBean,
                     java.lang.Integer aLanguageId,
                     java.lang.Long aCatEntryId,
                     com.ibm.commerce.command.CommandContext aCommandContext)

Price data bean constructor.

Parameters:

aMonetaryAmount - monetary amount of the price.

aStoreAccessBean - store under which the formatting is to occur.

aLanguageId - language Id under which the formatting is to occur.

aCatEntryId - the catalog entry id for the price.

aCommandContext - the command context.

Method Detail

getCatEntryId

public java.lang.Long getCatEntryId()

Gets the catalog entry id.

Specified by:

getCatEntryId in interface PriceSmartDataBean

Returns:

the Long containing the catalog entry id.

getPriceVAT

public java.math.BigDecimal getPriceVAT()
                                 throws com.ibm.commerce.exception.ECSystemException

Gets total of the price with VAT.

Returns:

total of the price with VAT

Throws:

com.ibm.commerce.exception.ECSystemException

getTaxes

public CategorizedMonetaryAmountsDataBean getTaxes()
                                            throws com.ibm.commerce.exception.ECSystemException

Invokes GetDisplayTaxes command to calculate the taxes for those tax categories that are displayable at product display time.

Specified by:

getTaxes in interface PriceSmartDataBean

Returns:

the CategorizedMonetaryAmountsDataBean containing the taxing monetary amounts, names and descriptions and so forth.

Throws:

com.ibm.commerce.exception.ECSystemException

setCatEntryId

public void setCatEntryId(java.lang.Long aCatEntryId)

Sets the catalog entry id

Specified by:

setCatEntryId in interface PriceInputDataBean

Parameters:

aCatEntryId - the catalog entry Id.

setStoreId

public void setStoreId(java.lang.Integer anStoreId)

sets store id (optional).

Parameters:

anStoreId - the store which calculation is based on.