com.ibm.commerce.price.beans

Class CategorizedMonetaryAmountsDataBean

java.lang.Object

com.ibm.commerce.price.utils.UnitAmountDataBeanImpl

com.ibm.commerce.price.utils.MonetaryAmountDataBean

com.ibm.commerce.price.beans.CategorizedMonetaryAmountsDataBean

All Implemented Interfaces:

CategorizedMonetaryAmountsInputDataBean, CategorizedMonetaryAmountsSmartDataBean

public class CategorizedMonetaryAmountsDataBean
extends MonetaryAmountDataBean
implements CategorizedMonetaryAmountsInputDataBean, CategorizedMonetaryAmountsSmartDataBean

This data bean represents a Categorized Monetary Amounts Data Bean object. When formatting multiple monetary amounts that are of different categories, the data bean will be called. One example that will use this formatter will be the taxation that can be composed of several tax categories (for example GST, PST). Sets the StoreAccessBean, LangId, CategoryName and MonetaryAmount in order to populate the bean.

Constructor Summary

Constructors

Constructor and Description
CategorizedMonetaryAmountsDataBean() CategorizedMonetaryAmountFormatter constructor.
CategorizedMonetaryAmountsDataBean(MonetaryAmount aMonetaryAmount, com.ibm.commerce.common.objects.StoreAccessBean aStoreAccessBean, java.lang.Integer aLangId, java.lang.String aCategoryName) CategorizedMonetaryAmountFormatter constructor.
CategorizedMonetaryAmountsDataBean(MonetaryAmount aMonetaryAmount, com.ibm.commerce.common.objects.StoreAccessBean aStoreAccessBean, java.lang.Integer aLangId, java.lang.String aCategoryName, java.util.Hashtable aDescHash, java.util.Hashtable aAmountHash, java.util.Hashtable aAmountDBHash) CategorizedMonetaryAmountFormatter constructor.
CategorizedMonetaryAmountsDataBean(MonetaryAmount aMonetaryAmount, com.ibm.commerce.common.objects.StoreAccessBean aStoreAccessBean, java.lang.Integer aLangId, java.lang.String aCategoryName, java.util.Hashtable aDescHash, java.util.Hashtable aAmountHash, java.util.Hashtable aAmountDBHash, java.util.HashMap aRateHash) CategorizedMonetaryAmountFormatter constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getACategorizedAmountWithName(java.lang.String aCategory) Returns the monetary amount and name of a particular category.
java.lang.String	getACategorizedValueWithName(java.lang.String aCategory) Returns the monetary value and name of a particular category.
java.lang.String	getAllCategorizedAmountsWithNames() Returns all of the categorized monetary amounts and names.
java.lang.String	getAllCategorizedAmountsWithNamesAndRates() Returns all of the categorized monetary amounts ,names and rates.
java.lang.String	getAllCategorizedValuesWithNames() Returns all of the categorized monetary values and names.
java.lang.String	getAllCategorizedValuesWithNamesAndRates() Returns all of the categorized monetary values , names and rates.
java.util.Hashtable	getCategorizedAmountsAndNames() Gets the categorized names and monetary amounts hashtable.
java.util.Hashtable	getCategorizedAmountsDBAndNames() Gets the categorized names and MonetaryAmountDataBean hashtable.
java.util.Hashtable	getCategorizedDescriptionsAndNames() Gets the categorized descriptions and names hashtable.
java.util.HashMap	getCategorizedRatesAndNames() Gets the categorized rates and names hashtable.
java.math.BigDecimal	getCategoryAmount() This method gets the category monetary value.
java.lang.String	getCategoryName() Gets the category name.
com.ibm.commerce.command.CommandContext	getCommandContext() Gets the command context.
java.lang.String	getCurrency() Gets the monetary currency.
int	getNoOfCategories() Returns the total number of categories.
com.ibm.commerce.datatype.TypedProperty	getRequestProperties() Gets the request properties.
java.lang.String	getTotalCategorizedAmount() Returns the total of all the categorized amounts.
java.lang.String	getTotalCategorizedValue() Returns the total of all the categorized amount values.
void	populate() This method is used to create the hashtable that contains the categories and their corresponding monetary amounts.
void	setCategorizedAmountsAndNames(java.util.Hashtable aCategorizedAmounts) Sets the categorized names and monetary amounts hashtable.
void	setCategorizedAmountsDBAndNames(java.util.Hashtable aCategorizedAmountsDB) Sets the categorized names and MonetaryAmountDataBean hashtable.
void	setCategorizedDescriptionsAndNames(java.util.Hashtable aCategorizedDescriptionsAndNames) Sets the categorized descriptions and names hashtable.
void	setCategorizedRatesAndNames(java.util.HashMap aCategorizedRatesAndNames) Sets the categorized rates and names hashtable.
void	setCategorizedValuesAndNames(java.util.Hashtable aCategorizedValues) Sets the categorized values and names hashtable.
void	setCategoryAmount(java.math.BigDecimal aCategoryAmount) Sets the category value.
void	setCategoryName(java.lang.String aCgryName) Sets the category name.
void	setCommandContext(com.ibm.commerce.command.CommandContext commandContext) Sets the command context.
void	setCurrency(java.lang.String aCurrency) Sets the monetary currency.
void	setRequestProperties(com.ibm.commerce.datatype.TypedProperty param) Sets the request properties.
java.lang.String	toString() Returns all of the categorized monetary amounts or monetary values and their corresponding category names.

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

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

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

CategorizedMonetaryAmountsDataBean

public CategorizedMonetaryAmountsDataBean()

CategorizedMonetaryAmountFormatter constructor.

CategorizedMonetaryAmountsDataBean

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

CategorizedMonetaryAmountFormatter constructor.

Parameters:

aStoreAccessBean -

aLangId -

aCategoryName -

aMonetaryAmount - com.ibm.commerce.price.utils.MonetaryAmount

CategorizedMonetaryAmountsDataBean

public CategorizedMonetaryAmountsDataBean(MonetaryAmount aMonetaryAmount,
                                          com.ibm.commerce.common.objects.StoreAccessBean aStoreAccessBean,
                                          java.lang.Integer aLangId,
                                          java.lang.String aCategoryName,
                                          java.util.Hashtable aDescHash,
                                          java.util.Hashtable aAmountHash,
                                          java.util.Hashtable aAmountDBHash)

CategorizedMonetaryAmountFormatter constructor.

Parameters:

aStoreAccessBean -

aLangId -

aCategoryName -

aDescHash -

aAmountHash -

aAmountDBHash -

aMonetaryAmount - com.ibm.commerce.price.utils.MonetaryAmount

CategorizedMonetaryAmountsDataBean

public CategorizedMonetaryAmountsDataBean(MonetaryAmount aMonetaryAmount,
                                          com.ibm.commerce.common.objects.StoreAccessBean aStoreAccessBean,
                                          java.lang.Integer aLangId,
                                          java.lang.String aCategoryName,
                                          java.util.Hashtable aDescHash,
                                          java.util.Hashtable aAmountHash,
                                          java.util.Hashtable aAmountDBHash,
                                          java.util.HashMap aRateHash)

CategorizedMonetaryAmountFormatter constructor.

Parameters:

aStoreAccessBean -

aLangId -

aCategoryName -

aDescHash -

aAmountHash -

aAmountDBHash -

aMonetaryAmount - com.ibm.commerce.price.utils.MonetaryAmount

aRateHash -

Method Detail

getACategorizedAmountWithName

public java.lang.String getACategorizedAmountWithName(java.lang.String aCategory)

Returns the monetary amount and name of a particular category.

Specified by:

getACategorizedAmountWithName in interface CategorizedMonetaryAmountsSmartDataBean

Parameters:

aCategory - - the category

Returns:

the String representing monetary amount and the corresponding name of a particular category.

getACategorizedValueWithName

public java.lang.String getACategorizedValueWithName(java.lang.String aCategory)

Returns the monetary value and name of a particular category.

Specified by:

getACategorizedValueWithName in interface CategorizedMonetaryAmountsSmartDataBean

Parameters:

aCategory - - the category

Returns:

the String representing monetary value and the corresponding name of a particular category.

getAllCategorizedAmountsWithNames

public java.lang.String getAllCategorizedAmountsWithNames()

Returns all of the categorized monetary amounts and names.

Specified by:

getAllCategorizedAmountsWithNames in interface CategorizedMonetaryAmountsSmartDataBean

Returns:

the String representing all of the categorized monetary amounts and the corresponding category names.

getAllCategorizedAmountsWithNamesAndRates

public java.lang.String getAllCategorizedAmountsWithNamesAndRates()

Returns all of the categorized monetary amounts ,names and rates. Currently this method is only applicable when VAT(value-added-tax) is enabled.

Returns:

the String representing all of the categorized monetary amounts and the corresponding category names and category rates.

getAllCategorizedValuesWithNames

public java.lang.String getAllCategorizedValuesWithNames()

Returns all of the categorized monetary values and names.

Specified by:

getAllCategorizedValuesWithNames in interface CategorizedMonetaryAmountsSmartDataBean

Returns:

the String representing all of the categorized monetary values and the corresponding category names.

getAllCategorizedValuesWithNamesAndRates

public java.lang.String getAllCategorizedValuesWithNamesAndRates()

Returns all of the categorized monetary values , names and rates. Currently this method is only applicable when VAT(value-added-tax) is enabled.

Returns:

the String representing all of the categorized monetary values and the corresponding category names and tax rates.

getCategorizedAmountsAndNames

public java.util.Hashtable getCategorizedAmountsAndNames()

Gets the categorized names and monetary amounts hashtable.

Specified by:

getCategorizedAmountsAndNames in interface CategorizedMonetaryAmountsSmartDataBean

Returns:

the Hashtable containing the categorized names and monetary amounts.

getCategorizedAmountsDBAndNames

public java.util.Hashtable getCategorizedAmountsDBAndNames()

Gets the categorized names and MonetaryAmountDataBean hashtable.

Specified by:

getCategorizedAmountsDBAndNames in interface CategorizedMonetaryAmountsSmartDataBean

Returns:

the Hashtable containing the categorized names and MonetaryAmountDataBean.

getCategorizedDescriptionsAndNames

public java.util.Hashtable getCategorizedDescriptionsAndNames()

Gets the categorized descriptions and names hashtable.

Specified by:

getCategorizedDescriptionsAndNames in interface CategorizedMonetaryAmountsSmartDataBean

Returns:

the Hashtable containing the categorized descriptions and names.

getCategorizedRatesAndNames

public java.util.HashMap getCategorizedRatesAndNames()

Gets the categorized rates and names hashtable. Currently this method is only applicable when VAT(Value-Added-Tax) is enabled. Then VAT is not enabled, this hash table is empty.

Returns:

the HashMap containing the categorized descriptions and names.

getCategoryAmount

public java.math.BigDecimal getCategoryAmount()

This method gets the category monetary value. When there is only 1 tax category applied to products, this field is to keep this specific tax category's amount. When there are more than 1 tax categories applied to products, this field is to save the total amount. Users can find the tax details for each categories in hash maps provided within this data bean.

Specified by:

getCategoryAmount in interface CategorizedMonetaryAmountsSmartDataBean

Returns:

the BigDecimal containing the monetary value.

getCategoryName

public java.lang.String getCategoryName()

Gets the category name.

Specified by:

getCategoryName in interface CategorizedMonetaryAmountsSmartDataBean

Returns:

the String containing the category name.

getCommandContext

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

Gets the command context.

Returns:

the com.ibm.commerce.command.CommandContext.

getCurrency

public java.lang.String getCurrency()

Gets the monetary currency.

Specified by:

getCurrency in interface CategorizedMonetaryAmountsSmartDataBean

Returns:

the String representing the monetary currency.

getNoOfCategories

public int getNoOfCategories()

Returns the total number of categories.

Specified by:

getNoOfCategories in interface CategorizedMonetaryAmountsSmartDataBean

Returns:

the intcontaining the total numbers of categories.

getRequestProperties

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

Gets the request properties.

Returns:

the com.ibm.commerce.datatype.TypedProperty containing the request properties.

getTotalCategorizedAmount

public java.lang.String getTotalCategorizedAmount()

Returns the total of all the categorized amounts.

Specified by:

getTotalCategorizedAmount in interface CategorizedMonetaryAmountsSmartDataBean

Returns:

the String representing the total monetary amount.

getTotalCategorizedValue

public java.lang.String getTotalCategorizedValue()

Returns the total of all the categorized amount values.

Specified by:

getTotalCategorizedValue in interface CategorizedMonetaryAmountsSmartDataBean

Returns:

the String representing the total monetary value.

populate

public void populate()
              throws java.lang.Exception

This method is used to create the hashtable that contains the categories and their corresponding monetary amounts. Loads data into the data bean when the DataBeanManager.activate() runs.

Throws:

java.lang.Exception

setCategorizedAmountsAndNames

public void setCategorizedAmountsAndNames(java.util.Hashtable aCategorizedAmounts)

Sets the categorized names and monetary amounts hashtable.

Specified by:

setCategorizedAmountsAndNames in interface CategorizedMonetaryAmountsInputDataBean

Parameters:

aCategorizedAmounts -

setCategorizedAmountsDBAndNames

public void setCategorizedAmountsDBAndNames(java.util.Hashtable aCategorizedAmountsDB)

Sets the categorized names and MonetaryAmountDataBean hashtable.

Specified by:

setCategorizedAmountsDBAndNames in interface CategorizedMonetaryAmountsInputDataBean

Parameters:

aCategorizedAmountsDB - the categorized amounts data bean and names hashtable.

setCategorizedDescriptionsAndNames

public void setCategorizedDescriptionsAndNames(java.util.Hashtable aCategorizedDescriptionsAndNames)

Sets the categorized descriptions and names hashtable.

Specified by:

setCategorizedDescriptionsAndNames in interface CategorizedMonetaryAmountsInputDataBean

Parameters:

aCategorizedDescriptionsAndNames -

setCategorizedRatesAndNames

public void setCategorizedRatesAndNames(java.util.HashMap aCategorizedRatesAndNames)

Sets the categorized rates and names hashtable.

Parameters:

aCategorizedRatesAndNames -

setCategorizedValuesAndNames

public void setCategorizedValuesAndNames(java.util.Hashtable aCategorizedValues)

Sets the categorized values and names hashtable.

Specified by:

setCategorizedValuesAndNames in interface CategorizedMonetaryAmountsInputDataBean

Parameters:

aCategorizedValues -

setCategoryAmount

public void setCategoryAmount(java.math.BigDecimal aCategoryAmount)

Sets the category value.

Specified by:

setCategoryAmount in interface CategorizedMonetaryAmountsInputDataBean

Parameters:

aCategoryAmount - the category value.

setCategoryName

public void setCategoryName(java.lang.String aCgryName)

Sets the category name.

Specified by:

setCategoryName in interface CategorizedMonetaryAmountsInputDataBean

Parameters:

aCgryName - the category name.

setCommandContext

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

Sets the command context.

Parameters:

commandContext - com.ibm.commerce.command.CommandContext.

setCurrency

public void setCurrency(java.lang.String aCurrency)

Sets the monetary currency.

Specified by:

setCurrency in interface CategorizedMonetaryAmountsInputDataBean

Parameters:

aCurrency - the monetary currency.

setRequestProperties

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

Sets the request properties.

Parameters:

param - com.ibm.commerce.datatype.TypedProperty.

Throws:

java.lang.Exception

toString

public java.lang.String toString()

Returns all of the categorized monetary amounts or monetary values and their corresponding category names.

Specified by:

toString in interface CategorizedMonetaryAmountsSmartDataBean

Overrides:

toString in class MonetaryAmountDataBean

Returns:

the String representing all of the categorized monetary amounts or monetary values and their corresponding category names.