com.ibm.commerce.store.util

Class CurrencyData

  • java.lang.Object
    • com.ibm.commerce.store.util.CurrencyData
  • All Implemented Interfaces:
    java.lang.Comparable


    public class CurrencyData
    extends java.lang.Object
    implements java.lang.Comparable
    This class represents a data object to store information related to a currency. It contains important information such as currency code and display description for a store.
    • Constructor Summary

      Constructors 
      Constructor and Description
      CurrencyData(java.lang.String inCode, java.lang.String inDescription)
      This method creates a currency data object with a given currency code and description.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      int compareTo(java.lang.Object aobj)
      Compares this object to another object.
      java.lang.String getCurrencyCode()
      This method gets the currency code.
      java.lang.String getCurrencyDescription()
      This method gets the store's currency description.
      void setCurrencyCode(java.lang.String inCode)
      This method gets the currency code.
      void setCurrencyDescription(java.lang.String inDescription)
      This method sets the store's currency description.
      java.lang.String toString()
      Returns a string representation of the object.
      • Methods inherited from class java.lang.Object

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

      • CurrencyData

        public CurrencyData(java.lang.String inCode,
                            java.lang.String inDescription)
        This method creates a currency data object with a given currency code and description.
        Parameters:
        inCode - The currency code
        inDescription - The currency description
    • Method Detail

      • compareTo

        public int compareTo(java.lang.Object aobj)
        Compares this object to another object.
        Specified by:
        compareTo in interface java.lang.Comparable
        Parameters:
        aobj - the Object to be compared.
        Returns:
        a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
        Throws:
        java.lang.ClassCastException - if the specified object's type prevents it from being compared to this object.
        See Also:
        Comparable
      • getCurrencyCode

        public java.lang.String getCurrencyCode()
        This method gets the currency code.
        Returns:
        The currency code
      • getCurrencyDescription

        public java.lang.String getCurrencyDescription()
        This method gets the store's currency description.
        Returns:
        The store's currency description
      • setCurrencyCode

        public void setCurrencyCode(java.lang.String inCode)
        This method gets the currency code.
        Parameters:
        inCode - The currency code
      • setCurrencyDescription

        public void setCurrencyDescription(java.lang.String inDescription)
        This method sets the store's currency description.
        Parameters:
        inDescription - The currency description
      • toString

        public java.lang.String toString()
        Returns a string representation of the object.
        Overrides:
        toString in class java.lang.Object
        Returns:
        a string representation of the object.
        See Also:
        Object