com.ibm.commerce.price.beans

Class FormattedMonetaryAmountDataBean

java.lang.Object

com.ibm.commerce.price.utils.UnitAmountDataBeanImpl

com.ibm.commerce.price.utils.MonetaryAmountDataBean

com.ibm.commerce.price.beans.FormattedMonetaryAmountDataBean

All Implemented Interfaces:

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

Direct Known Subclasses:

FloorPriceDataBean, PriceDataBean

public class FormattedMonetaryAmountDataBean
extends MonetaryAmountDataBean
implements FormattedMonetaryAmountInputDataBean, FormattedMonetaryAmountSmartDataBean

This data bean represents a Formatted Monetary Amount Data Bean object. When formatting monetary amounts, the data bean will be called. Sets monetary amount, StoreAccessBean and language Id in order to populate the bean.

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
FormattedMonetaryAmountDataBean() Formatted monetary amount data bean default constructor.
FormattedMonetaryAmountDataBean(MonetaryAmount aMonetaryAmount, com.ibm.commerce.common.objects.StoreAccessBean aStoreAccessBean, java.lang.Integer aLangId) Formatted monetary amount data bean constructor.

Method Summary

Modifier and Type	Method and Description
java.math.BigDecimal	getAmount() Gets the amount to be formatted.
com.ibm.commerce.command.CommandContext	getCommandContext() Gets the command context.
java.lang.String	getCurrency() Gets the currency of the monetary amount.
com.ibm.commerce.datatype.TypedProperty	getRequestProperties() Gets request properties.
void	populate() This method is used to create the formatted monetary amount.
void	setAmount(java.math.BigDecimal newAmount) Sets the value of the monetary amount.
void	setCommandContext(com.ibm.commerce.command.CommandContext commandContext) Sets the command context.
void	setCurrency(java.lang.String newCurrency) Sets the monetary currency.
void	setRequestProperties(com.ibm.commerce.datatype.TypedProperty param) Sets request properties (not implemented).

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

Constructor Detail

FormattedMonetaryAmountDataBean

public FormattedMonetaryAmountDataBean()

Formatted monetary amount data bean default constructor.

FormattedMonetaryAmountDataBean

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

Formatted monetary amount data bean constructor.

Parameters:

aMonetaryAmount - monetary amount to format.

aStoreAccessBean - store under which the formatting is to occur.

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

Method Detail

getAmount

public java.math.BigDecimal getAmount()

Gets the amount to be formatted.

Specified by:

getAmount in interface FormattedMonetaryAmountSmartDataBean

Returns:

the amount.

getCommandContext

public com.ibm.commerce.command.CommandContext getCommandContext()

Gets the command context.

Specified by:

getCommandContext in interface com.ibm.commerce.beans.SmartDataBean

Returns:

the command context.

getCurrency

public java.lang.String getCurrency()

Gets the currency of the monetary amount.

Specified by:

getCurrency in interface FormattedMonetaryAmountSmartDataBean

Returns:

the currency.

getRequestProperties

public com.ibm.commerce.datatype.TypedProperty getRequestProperties()

Gets request properties.

Specified by:

getRequestProperties in interface com.ibm.commerce.beans.InputDataBean

Returns:

null.

populate

public void populate()
              throws java.lang.Exception

This method is used to create the formatted monetary amount. Loads data into the data bean when the DataBeanManager.activate() runs.

Specified by:

populate in interface com.ibm.commerce.beans.SmartDataBean

Throws:

java.lang.Exception

setAmount

public void setAmount(java.math.BigDecimal newAmount)

Sets the value of the monetary amount. If this method is not called, zero is assumed.

Specified by:

setAmount in interface FormattedMonetaryAmountInputDataBean

Parameters:

newAmount - monetary value.

setCommandContext

public void setCommandContext(com.ibm.commerce.command.CommandContext commandContext)

Sets the command context.

Specified by:

setCommandContext in interface com.ibm.commerce.beans.SmartDataBean

Parameters:

commandContext - the command context.

setCurrency

public void setCurrency(java.lang.String newCurrency)

Sets the monetary currency. If this method is not called then the currency is retrieved from the command context.

Specified by:

setCurrency in interface FormattedMonetaryAmountInputDataBean

Parameters:

newCurrency - monetary currency.

setRequestProperties

public void setRequestProperties(com.ibm.commerce.datatype.TypedProperty param)
                          throws java.lang.Exception

Sets request properties (not implemented).

Specified by:

setRequestProperties in interface com.ibm.commerce.beans.InputDataBean

Parameters:

param - com.ibm.commerce.datatype.TypedProperty

Throws:

java.lang.Exception