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:

DataBean, InputDataBean, 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 class com.ibm.commerce.price.utils.MonetaryAmountDataBean
  iCounterValueListPrefix, iCounterValueListSeparator, iCounterValueListSuffix
- 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, StoreAccessBean aStoreAccessBean, java.lang.Integer aLangId)` Formatted monetary amount data bean constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`java.math.BigDecimal`	`getAmount()` Gets the amount to be formatted.
`CommandContext`	`getCommandContext()` Gets the command context.
`java.lang.String`	`getCurrency()` Gets the currency of the monetary amount.
`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(CommandContext commandContext)` Sets the command context.
`void`	`setCurrency(java.lang.String newCurrency)` Sets the monetary currency.
`void`	`setRequestProperties(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
formatAmount, getCustomizedString, getDescription, getLangId, getNumberUsage, getPrimaryAmount, getPrimaryFormattedAmount, getStoreAccessBean, getSymbol, roundAmount, setLangId, setNumberUsage, setPrimaryAmount, setStoreAccessBean, setUnitManager

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

- Constructor Detail
  - FormattedMonetaryAmountDataBean
```
public FormattedMonetaryAmountDataBean()
```
    Formatted monetary amount data bean default constructor.
  - FormattedMonetaryAmountDataBean
```
public FormattedMonetaryAmountDataBean(MonetaryAmount aMonetaryAmount,
                               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 CommandContext getCommandContext()
```
    Gets the command context.
    
    Specified by:
    
    getCommandContext in interface 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 TypedProperty getRequestProperties()
```
    Gets request properties.
    
    Specified by:
    
    getRequestProperties in interface 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 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(CommandContext commandContext)
```
    Sets the command context.
    
    Specified by:
    
    setCommandContext in interface 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(TypedProperty param)
                          throws java.lang.Exception
```
    Sets request properties (not implemented).
    
    Specified by:
    
    setRequestProperties in interface InputDataBean
    
    Parameters:
    
    param - com.ibm.commerce.datatype.TypedProperty
    
    Throws:
    
    java.lang.Exception

Class FormattedMonetaryAmountDataBean

Field Summary

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Constructor Detail

FormattedMonetaryAmountDataBean

FormattedMonetaryAmountDataBean

Method Detail

getAmount

getCommandContext

getCurrency

getRequestProperties

populate

setAmount

setCommandContext

setCurrency

setRequestProperties