com.ibm.commerce.common.objects
Class QuantityUnitFormatDescriptionBean

com.ibm.commerce.common.objects.QuantityUnitFormatDescriptionBean
All Implemented Interfaces:
java.io.Serializable

public class QuantityUnitFormatDescriptionBean
implements java.io.Serializable

This bean provides access to the QTYFMTDESC table.

The following is a description of this table:

Each row of this table represents the Language-dependent part of a QuantityUnit formatting rule. It describes how to format (for display purposes) a quantity amount in a particular QuantityUnit, in a particular Language.

See Also:
Serialized Form

Constructor Summary
QuantityUnitFormatDescriptionBean()
           
 
Method Summary
 java.lang.String getCustomizedQuantityString()
          This method provides access to the QTYFMTDESC.CUSTOMIZEDQTYSTR column of DB2 type VARCHAR(254) NULL.
 java.lang.String getDescription()
          This method provides access to the QTYFMTDESC.DESCRIPTION column of DB2 type VARCHAR(254) NULL.
 java.lang.String getDisplayLocale()
          This method provides access to the QTYFMTDESC.DISPLAYLOCALE column of DB2 type CHAR(16) NULL.
 java.lang.String getGroupingCharacter()
          This method provides access to the QTYFMTDESC.GROUPINGCHAR column of DB2 type CHAR(1) NULL.
 java.lang.Integer getLanguageId()
          This method provides access to the QTYFMTDESC.LANGUAGE_ID column of DB2 type INTEGER NOT NULL.
 java.lang.String getNumberPattern()
          This method provides access to the QTYFMTDESC.NUMBERPATTERN column of DB2 type VARCHAR(254) NULL.
 java.lang.Integer getNumberUsgId()
          This method provides access to the QTYFMTDESC.NUMBRUSG_ID column of DB2 type INTEGER NOT NULL.
 java.lang.String getQuantityUnitId()
          This method provides access to the QTYFMTDESC.QTYUNIT_ID column of DB2 type CHAR(16) NOT NULL.
 java.lang.String getRadixPoint()
          This method provides access to the QTYFMTDESC.RADIXPOINT column of DB2 type CHAR(1) NULL.
 java.lang.Integer getStoreEntityId()
          This method provides access to the QTYFMTDESC.STOREENT_ID column of DB2 type INTEGER NOT NULL.
 java.lang.String getUnitPrefixNegative()
          This method provides access to the QTYFMTDESC.UNITPREFIXNEG column of DB2 type VARCHAR(254) NULL.
 java.lang.String getUnitPrefixPositive()
          This method provides access to the QTYFMTDESC.UNITPREFIXPOS column of DB2 type VARCHAR(254) NULL.
 java.lang.String getUnitSuffixNegative()
          This method provides access to the QTYFMTDESC.UNITSUFFIXNEG column of DB2 type VARCHAR(254) NULL.
 java.lang.String getUnitSuffixPositive()
          This method provides access to the QTYFMTDESC.UNITSUFFIXPOS column of DB2 type VARCHAR(254) NULL.
 java.lang.String getUnitSymbol()
          This method provides access to the QTYFMTDESC.UNITSYMBOL column of DB2 type VARCHAR(254) NULL.
 void setCustomizedQuantityString(java.lang.String aCustomizedQuantityString)
          This method provides access to the QTYFMTDESC.CUSTOMIZEDQTYSTR column of DB2 type VARCHAR(254) NULL.
 void setDescription(java.lang.String aDescription)
          This method provides access to the QTYFMTDESC.DESCRIPTION column of DB2 type VARCHAR(254) NULL.
 void setDisplayLocale(java.lang.String aDisplayLocale)
          This method provides access to the QTYFMTDESC.DISPLAYLOCALE column of DB2 type CHAR(16) NULL.
 void setGroupingCharacter(java.lang.String aGroupingCharacter)
          This method provides access to the QTYFMTDESC.GROUPINGCHAR column of DB2 type CHAR(1) NULL.
 void setLanguageId(java.lang.Integer aLanguageId)
          This method provides access to the QTYFMTDESC.LANGUAGE_ID column of DB2 type INTEGER NOT NULL.
 void setNumberPattern(java.lang.String aNumberPattern)
          This method provides access to the QTYFMTDESC.NUMBERPATTERN column of DB2 type VARCHAR(254) NULL.
 void setNumberUsgId(java.lang.Integer aNumberUsgId)
          This method provides access to the QTYFMTDESC.NUMBRUSG_ID column of DB2 type INTEGER NOT NULL.
 void setQuantityUnitId(java.lang.String aQuantityUnitId)
          This method provides access to the QTYFMTDESC.QTYUNIT_ID column of DB2 type CHAR(16) NOT NULL.
 void setRadixPoint(java.lang.String aRadixPoint)
          This method provides access to the QTYFMTDESC.RADIXPOINT column of DB2 type CHAR(1) NULL.
 void setStoreEntityId(java.lang.Integer aStoreEntityId)
          This method provides access to the QTYFMTDESC.STOREENT_ID column of DB2 type INTEGER NOT NULL.
 void setUnitPrefixNegative(java.lang.String aUnitPrefixNegative)
          This method provides access to the QTYFMTDESC.UNITPREFIXNEG column of DB2 type VARCHAR(254) NULL.
 void setUnitPrefixPositive(java.lang.String aUnitPrefixPositive)
          This method provides access to the QTYFMTDESC.UNITPREFIXPOS column of DB2 type VARCHAR(254) NULL.
 void setUnitSuffixNegative(java.lang.String aUnitSuffixNegative)
          This method provides access to the QTYFMTDESC.UNITSUFFIXNEG column of DB2 type VARCHAR(254) NULL.
 void setUnitSuffixPositive(java.lang.String aUnitSuffixPositive)
          This method provides access to the QTYFMTDESC.UNITSUFFIXPOS column of DB2 type VARCHAR(254) NULL.
 void setUnitSymbol(java.lang.String aUnitSymbol)
          This method provides access to the QTYFMTDESC.UNITSYMBOL column of DB2 type VARCHAR(254) NULL.
 

Constructor Detail

QuantityUnitFormatDescriptionBean

public QuantityUnitFormatDescriptionBean()
Method Detail

getCustomizedQuantityString

public java.lang.String getCustomizedQuantityString()

This method provides access to the QTYFMTDESC.CUSTOMIZEDQTYSTR column of DB2 type VARCHAR(254) NULL.

The following is a description of this column:

An alternate QuantityUnit code. WebSphere Commerce does not use this value. You may supply a value and write your JSP macros to use it.

Returns:
java.lang.String

getDescription

public java.lang.String getDescription()

This method provides access to the QTYFMTDESC.DESCRIPTION column of DB2 type VARCHAR(254) NULL.

The following is a description of this column:

A description of the QuantityUnit, suitable for display to customers in a QuantityUnit selection list.

Returns:
java.lang.String

getDisplayLocale

public java.lang.String getDisplayLocale()

This method provides access to the QTYFMTDESC.DISPLAYLOCALE column of DB2 type CHAR(16) NULL.

The following is a description of this column:

The Java locale used to create a QuantityUnit NumberFormat object that is used to do the formatting. If this is NULL then the locale associated with the LANGUAGE_ID (see the LANGUAGE table) is used.

Returns:
java.lang.String

getGroupingCharacter

public java.lang.String getGroupingCharacter()

This method provides access to the QTYFMTDESC.GROUPINGCHAR column of DB2 type CHAR(1) NULL.

The following is a description of this column:

The grouping character used by the NumberFormat object. Refer to QTYFMTDESC table: details for more information.

Returns:
java.lang.String

getLanguageId

public java.lang.Integer getLanguageId()

This method provides access to the QTYFMTDESC.LANGUAGE_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

The Language. For a list of language components, see the LANGUAGE table.

Returns:
java.lang.Integer

getNumberPattern

public java.lang.String getNumberPattern()

This method provides access to the QTYFMTDESC.NUMBERPATTERN column of DB2 type VARCHAR(254) NULL.

The following is a description of this column:

The number pattern to be applied to the NumberFormat object. The number pattern is described in the JDK documentation for the class java.text.DecimalFormat. If this is NULL then the default number pattern of the NumberFormat object is used.

Returns:
java.lang.String

getNumberUsgId

public java.lang.Integer getNumberUsgId()

This method provides access to the QTYFMTDESC.NUMBRUSG_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

This QuantityUnit formatting rule should be used when formatting quantity amounts for this usage.

Returns:
java.lang.Integer

getQuantityUnitId

public java.lang.String getQuantityUnitId()

This method provides access to the QTYFMTDESC.QTYUNIT_ID column of DB2 type CHAR(16) NOT NULL.

The following is a description of this column:

The QuantityUnit.

Returns:
java.lang.String

getRadixPoint

public java.lang.String getRadixPoint()

This method provides access to the QTYFMTDESC.RADIXPOINT column of DB2 type CHAR(1) NULL.

The following is a description of this column:

The radix point for the NumberFormat object. Refer to QTYFMTDESC table: details for more information.

Returns:
java.lang.String

getStoreEntityId

public java.lang.Integer getStoreEntityId()

This method provides access to the QTYFMTDESC.STOREENT_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

The StoreEntity this formatting rule is part of.

Returns:
java.lang.Integer

getUnitPrefixNegative

public java.lang.String getUnitPrefixNegative()

This method provides access to the QTYFMTDESC.UNITPREFIXNEG column of DB2 type VARCHAR(254) NULL.

The following is a description of this column:

The prefix to use when the quantity amount is negative. If this field and UNITSUFFIXNEG are null then the negativePrefix of the NumberFormat will be used.

Returns:
java.lang.String

getUnitPrefixPositive

public java.lang.String getUnitPrefixPositive()

This method provides access to the QTYFMTDESC.UNITPREFIXPOS column of DB2 type VARCHAR(254) NULL.

The following is a description of this column:

The prefix to use when the quantity amount is positive. If this field and UNITSUFFIXPOS are null then the positivePrefix of the NumberFormat will be used.

Returns:
java.lang.String

getUnitSuffixNegative

public java.lang.String getUnitSuffixNegative()

This method provides access to the QTYFMTDESC.UNITSUFFIXNEG column of DB2 type VARCHAR(254) NULL.

The following is a description of this column:

The suffix to use when the quantity amount is negative. If this field and UNITPREFIXNEG are null then the negativeSuffix of the NumberFormat will be used.

Returns:
java.lang.String

getUnitSuffixPositive

public java.lang.String getUnitSuffixPositive()

This method provides access to the QTYFMTDESC.UNITSUFFIXPOS column of DB2 type VARCHAR(254) NULL.

The following is a description of this column:

The suffix to use when the quantity amount is positive. If this field and UNITPREFIXPOS are null then the positiveSuffix of the NumberFormat will be used.

Returns:
java.lang.String

getUnitSymbol

public java.lang.String getUnitSymbol()

This method provides access to the QTYFMTDESC.UNITSYMBOL column of DB2 type VARCHAR(254) NULL.

The following is a description of this column:

The QuantityUnit symbol.

Returns:
java.lang.String

setCustomizedQuantityString

public void setCustomizedQuantityString(java.lang.String aCustomizedQuantityString)

This method provides access to the QTYFMTDESC.CUSTOMIZEDQTYSTR column of DB2 type VARCHAR(254) NULL.

The following is a description of this column:

An alternate QuantityUnit code. WebSphere Commerce does not use this value. You may supply a value and write your JSP macros to use it.

Parameters:
aCustomizedQuantityString - java.lang.String
Returns:
void

setDescription

public void setDescription(java.lang.String aDescription)

This method provides access to the QTYFMTDESC.DESCRIPTION column of DB2 type VARCHAR(254) NULL.

The following is a description of this column:

A description of the QuantityUnit, suitable for display to customers in a QuantityUnit selection list.

Parameters:
aDescription - java.lang.String
Returns:
void

setDisplayLocale

public void setDisplayLocale(java.lang.String aDisplayLocale)

This method provides access to the QTYFMTDESC.DISPLAYLOCALE column of DB2 type CHAR(16) NULL.

The following is a description of this column:

The Java locale used to create a QuantityUnit NumberFormat object that is used to do the formatting. If this is NULL then the locale associated with the LANGUAGE_ID (see the LANGUAGE table) is used.

Parameters:
aDisplayLocale - java.lang.String
Returns:
void

setGroupingCharacter

public void setGroupingCharacter(java.lang.String aGroupingCharacter)

This method provides access to the QTYFMTDESC.GROUPINGCHAR column of DB2 type CHAR(1) NULL.

The following is a description of this column:

The grouping character used by the NumberFormat object. Refer to QTYFMTDESC table: details for more information.

Parameters:
aGroupingCharacter - java.lang.String
Returns:
void

setLanguageId

public void setLanguageId(java.lang.Integer aLanguageId)

This method provides access to the QTYFMTDESC.LANGUAGE_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

The Language. For a list of language components, see the LANGUAGE table.

Parameters:
aLanguageId - java.lang.Integer
Returns:
void

setNumberPattern

public void setNumberPattern(java.lang.String aNumberPattern)

This method provides access to the QTYFMTDESC.NUMBERPATTERN column of DB2 type VARCHAR(254) NULL.

The following is a description of this column:

The number pattern to be applied to the NumberFormat object. The number pattern is described in the JDK documentation for the class java.text.DecimalFormat. If this is NULL then the default number pattern of the NumberFormat object is used.

Parameters:
aNumberPattern - java.lang.String
Returns:
void

setNumberUsgId

public void setNumberUsgId(java.lang.Integer aNumberUsgId)

This method provides access to the QTYFMTDESC.NUMBRUSG_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

This QuantityUnit formatting rule should be used when formatting quantity amounts for this usage.

Parameters:
aNumberUsgId - java.lang.Integer
Returns:
void

setQuantityUnitId

public void setQuantityUnitId(java.lang.String aQuantityUnitId)

This method provides access to the QTYFMTDESC.QTYUNIT_ID column of DB2 type CHAR(16) NOT NULL.

The following is a description of this column:

The QuantityUnit.

Parameters:
aQuantityUnitId - java.lang.String
Returns:
void

setRadixPoint

public void setRadixPoint(java.lang.String aRadixPoint)

This method provides access to the QTYFMTDESC.RADIXPOINT column of DB2 type CHAR(1) NULL.

The following is a description of this column:

The radix point for the NumberFormat object. Refer to QTYFMTDESC table: details for more information.

Parameters:
aRadixPoint - java.lang.String
Returns:
void

setStoreEntityId

public void setStoreEntityId(java.lang.Integer aStoreEntityId)

This method provides access to the QTYFMTDESC.STOREENT_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

The StoreEntity this formatting rule is part of.

Parameters:
aStoreEntityId - java.lang.Integer
Returns:
void

setUnitPrefixNegative

public void setUnitPrefixNegative(java.lang.String aUnitPrefixNegative)

This method provides access to the QTYFMTDESC.UNITPREFIXNEG column of DB2 type VARCHAR(254) NULL.

The following is a description of this column:

The prefix to use when the quantity amount is negative. If this field and UNITSUFFIXNEG are null then the negativePrefix of the NumberFormat will be used.

Parameters:
aUnitPrefixNegative - java.lang.String
Returns:
void

setUnitPrefixPositive

public void setUnitPrefixPositive(java.lang.String aUnitPrefixPositive)

This method provides access to the QTYFMTDESC.UNITPREFIXPOS column of DB2 type VARCHAR(254) NULL.

The following is a description of this column:

The prefix to use when the quantity amount is positive. If this field and UNITSUFFIXPOS are null then the positivePrefix of the NumberFormat will be used.

Parameters:
aUnitPrefixPositive - java.lang.String
Returns:
void

setUnitSuffixNegative

public void setUnitSuffixNegative(java.lang.String aUnitSuffixNegative)

This method provides access to the QTYFMTDESC.UNITSUFFIXNEG column of DB2 type VARCHAR(254) NULL.

The following is a description of this column:

The suffix to use when the quantity amount is negative. If this field and UNITPREFIXNEG are null then the negativeSuffix of the NumberFormat will be used.

Parameters:
aUnitSuffixNegative - java.lang.String
Returns:
void

setUnitSuffixPositive

public void setUnitSuffixPositive(java.lang.String aUnitSuffixPositive)

This method provides access to the QTYFMTDESC.UNITSUFFIXPOS column of DB2 type VARCHAR(254) NULL.

The following is a description of this column:

The suffix to use when the quantity amount is positive. If this field and UNITPREFIXPOS are null then the positiveSuffix of the NumberFormat will be used.

Parameters:
aUnitSuffixPositive - java.lang.String
Returns:
void

setUnitSymbol

public void setUnitSymbol(java.lang.String aUnitSymbol)

This method provides access to the QTYFMTDESC.UNITSYMBOL column of DB2 type VARCHAR(254) NULL.

The following is a description of this column:

The QuantityUnit symbol.

Parameters:
aUnitSymbol - java.lang.String
Returns:
void