com.ibm.commerce.common.beans

Class StoreCurrencyFormatDescriptionDataBean

  • java.lang.Object
    • com.ibm.commerce.common.beans.StoreCurrencyFormatDescriptionDataBean
  • All Implemented Interfaces:
    com.ibm.commerce.beans.DataBean, com.ibm.commerce.beans.InputDataBean, com.ibm.commerce.beans.SmartDataBean, java.io.Serializable


    public final class StoreCurrencyFormatDescriptionDataBean
    extends java.lang.Object
    implements com.ibm.commerce.beans.SmartDataBean
    This databean represents a CurrencyFormatDescription object for use on the store front. This bean is an extension of the CurrencyFormatDescriptionDataBean. The CurrencyManager is used in this bean to cache results for currency symbol and decimal places to improve performance on the store front. Here is a sample usage for a JSP:
    See Also:
    Serialized Form
    • Field Summary

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

        emptyString
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      com.ibm.commerce.command.CommandContext getCommandContext()
      This method returns the command context set within this bean.
      java.lang.String getCurrencyCode()
      Returns the currency code for the specified currency.
      java.lang.String getCurrencySymbol()
      Returns the currency symbol for the specified currency.
      java.lang.String getDecimalPlaces()
      Returns the number of decimal places for a specified currency.
      java.lang.String getLangId()
      Returns the language ID.
      java.lang.String getNumberUsage()
      Return the number usage.
      com.ibm.commerce.datatype.TypedProperty getRequestProperties()
      This method returns the request property set within this bean.
      java.lang.String getStoreId()
      Returns the store ID in use.
      void populate()
      This method is used to populate the CurrencyFormatDescriptionDataBean.
      void setCommandContext(com.ibm.commerce.command.CommandContext aCommandContext)
      This method sets the command context within this bean.
      void setCurrencyCode(java.lang.String astrCurrencyCode)
      Sets the currency code to use for finding more information about this currency.
      void setCurrencySymbol(java.lang.String astrCurrencySymbol)
      Sets the currency symbol for the specified currency.
      void setLangId(java.lang.String astrLangId)
      Sets the language ID to use.
      void setNumberUsage(java.lang.String astrNumberUsage)
      Set the number usage, such as '-1'.
      void setRequestProperties(com.ibm.commerce.datatype.TypedProperty aRequestProperty)
      This method sets the request property within this bean.
      void setStoreId(java.lang.String astrStoreId)
      Set the store ID to use.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • StoreCurrencyFormatDescriptionDataBean

        public StoreCurrencyFormatDescriptionDataBean()
    • Method Detail

      • getCommandContext

        public com.ibm.commerce.command.CommandContext getCommandContext()
        This method returns the command context set within this bean.
        Specified by:
        getCommandContext in interface com.ibm.commerce.beans.SmartDataBean
        Returns:
        com.ibm.commerce.command.CommandContext
      • getCurrencyCode

        public java.lang.String getCurrencyCode()
        Returns the currency code for the specified currency.
        Returns:
        The currency code of the specified currency.
      • getCurrencySymbol

        public java.lang.String getCurrencySymbol()
                                           throws com.ibm.commerce.exception.ECSystemException
        Returns the currency symbol for the specified currency.
        Returns:
        The currency symbol for the currency in use.
        Throws:
        com.ibm.commerce.exception.ECSystemException
      • getDecimalPlaces

        public java.lang.String getDecimalPlaces()
                                          throws com.ibm.commerce.exception.ECSystemException
        Returns the number of decimal places for a specified currency.
        Returns:
        The number of decimal places for the specified currency.
        Throws:
        com.ibm.commerce.exception.ECSystemException
      • getLangId

        public java.lang.String getLangId()
        Returns the language ID.
        Returns:
        The language ID.
      • getNumberUsage

        public java.lang.String getNumberUsage()
        Return the number usage.
        Returns:
        The number usage.
      • getRequestProperties

        public com.ibm.commerce.datatype.TypedProperty getRequestProperties()
        This method returns the request property set within this bean.
        Specified by:
        getRequestProperties in interface com.ibm.commerce.beans.InputDataBean
        Returns:
        com.ibm.commerce.datatype.TypedProperty
      • getStoreId

        public java.lang.String getStoreId()
        Returns the store ID in use.
        Returns:
        The store ID in use.
      • populate

        public void populate()
                      throws java.lang.Exception
        This method is used to populate the CurrencyFormatDescriptionDataBean.
        Specified by:
        populate in interface com.ibm.commerce.beans.SmartDataBean
        Throws:
        java.lang.Exception
      • setCommandContext

        public void setCommandContext(com.ibm.commerce.command.CommandContext aCommandContext)
        This method sets the command context within this bean.
        Specified by:
        setCommandContext in interface com.ibm.commerce.beans.SmartDataBean
        Parameters:
        aCommandContext - com.ibm.commerce.command.CommandContext
      • setCurrencyCode

        public void setCurrencyCode(java.lang.String astrCurrencyCode)
        Sets the currency code to use for finding more information about this currency.
        Parameters:
        astrCurrencyCode - The currency code to use to determine what currency is in use.
      • setCurrencySymbol

        public void setCurrencySymbol(java.lang.String astrCurrencySymbol)
        Sets the currency symbol for the specified currency.
        Parameters:
        astrCurrencySymbol - The currency symbol to use for the specified currency.
      • setLangId

        public void setLangId(java.lang.String astrLangId)
        Sets the language ID to use.
        Parameters:
        astrLangId - The language ID to use such as '-1' for en_US.
      • setNumberUsage

        public void setNumberUsage(java.lang.String astrNumberUsage)
        Set the number usage, such as '-1'.
        Parameters:
        astrNumberUsage - The number usage to set.
      • setRequestProperties

        public void setRequestProperties(com.ibm.commerce.datatype.TypedProperty aRequestProperty)
        This method sets the request property within this bean.
        Specified by:
        setRequestProperties in interface com.ibm.commerce.beans.InputDataBean
        Parameters:
        aRequestProperty -
      • setStoreId

        public void setStoreId(java.lang.String astrStoreId)
        Set the store ID to use.
        Parameters:
        astrStoreId - The store ID to use.