com.ibm.commerce.price.utils

Class UnitAmountDataBeanImpl

java.lang.Object

com.ibm.commerce.price.utils.UnitAmountDataBeanImpl

Direct Known Subclasses:

MonetaryAmountDataBean, QuantityAmountDataBeanImpl

public class UnitAmountDataBeanImpl
extends java.lang.Object

Monetary amount data bean service class.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCustomizedString() Gets the customized string from the format table.
java.lang.String	getDescription() Gets the description of the specified unit.
java.lang.Integer	getLangId() Gets the language Id used to decide how to format the unit amounts.
java.lang.String	getNumberUsage() Gets the number usage that was used to format the amount.
com.ibm.commerce.common.objects.StoreAccessBean	getStoreAccessBean() Gets the store access bean.
java.lang.String	getSymbol() Gets the unit symbol information from the format table.
void	setLangId(java.lang.Integer newLangId) Sets the language Id to use for the formatting.
void	setNumberUsage(java.lang.String newNumberUsage) (Optional) Set the number usage for the formatting.
void	setStoreAccessBean(com.ibm.commerce.common.objects.StoreAccessBean newStoreAccessBean) Sets the store access bean to use for formatting.
java.lang.String	toString() Returns a String that represents the value of this object.

Methods inherited from class java.lang.Object

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

Method Detail

getCustomizedString

public java.lang.String getCustomizedString()
                                     throws com.ibm.commerce.exception.ECSystemException

Gets the customized string from the format table.

Returns:

the customized string from the format table.

Throws:

com.ibm.commerce.exception.ECSystemException

getDescription

public java.lang.String getDescription()
                                throws com.ibm.commerce.exception.ECSystemException

Gets the description of the specified unit.

Returns:

the unit description.

Throws:

com.ibm.commerce.exception.ECSystemException

getLangId

public java.lang.Integer getLangId()

Gets the language Id used to decide how to format the unit amounts.

Returns:

the language Id.

getNumberUsage

public java.lang.String getNumberUsage()

Gets the number usage that was used to format the amount.

Returns:

The number usage.

getStoreAccessBean

public com.ibm.commerce.common.objects.StoreAccessBean getStoreAccessBean()

Gets the store access bean.

Returns:

com.ibm.commerce.common.objects.StoreAccessBean

getSymbol

public java.lang.String getSymbol()
                           throws com.ibm.commerce.exception.ECSystemException

Gets the unit symbol information from the format table.

Returns:

the unit symbol.

Throws:

com.ibm.commerce.exception.ECSystemException

setLangId

public void setLangId(java.lang.Integer newLangId)

Sets the language Id to use for the formatting.

Parameters:

newLangId - language Id.

setNumberUsage

public void setNumberUsage(java.lang.String newNumberUsage)

(Optional) Set the number usage for the formatting. If not set, the default number usage will be used.

Parameters:

newNumberUsage - The number usage code.

setStoreAccessBean

public void setStoreAccessBean(com.ibm.commerce.common.objects.StoreAccessBean newStoreAccessBean)

Sets the store access bean to use for formatting.

Parameters:

newStoreAccessBean - store access bean.

toString

public java.lang.String toString()

Returns a String that represents the value of this object. The string includes the formatted unit amount

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the unit amount.