com.ibm.commerce.marketing.promotion.dependency

Class CatalogEntryKey

  • java.lang.Object
    • com.ibm.commerce.marketing.promotion.dependency.CatalogEntryKey
  • All Implemented Interfaces:
    Key, NumericKey, XMLizable, java.io.Serializable


    public class CatalogEntryKey
    extends java.lang.Object
    implements XMLizable, NumericKey
    The key to represent a catalog entry in the store. A CatalogEntryKey is composed of a Distinguished Name (DN) and a Stock keeping unit (SKU) for the catalog entry.

    XML Snippet for CatalogEntryKey:

      <CatalogEntryKey>
            <SKU>FULO-01</SKU>
            <DN>ou=b2c,o=seller organization,o=root organization</DN>
      </CatalogEntryKey>  
     
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      IBM copyright notice field.
    • Constructor Summary

      Constructors 
      Constructor and Description
      CatalogEntryKey()
      Default Constructor for CatalogEntryKey.
      CatalogEntryKey(java.lang.String aDN, java.lang.String aSKU)
      Constructor for CatalogEntryKey.
      CatalogEntryKey(java.lang.String aDN, java.lang.String aSKU, StoreKey aStore)
      Constructor for CatalogEntryKey.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      boolean equals(java.lang.Object obj)
      Returns true if this CatalogEntry key equals to another CatalogEntry key.
      void fromXML(org.w3c.dom.Node node)
      Transforms the XML node into its corresponding real Object.
      java.lang.String getDN()
      Returns the DN of the catalog entry key.
      java.lang.Number getNumericKey()
      Returns the numeric key associated with catalog entry key.
      java.lang.String getSKU()
      Returns the SKU of the catalog entry key.
      StoreKey getStore()
      Returns the store key associated with the catalog entry key.
      int hashCode()
      Returns the hashcode of the CatalogEntry key.
      boolean isNumericKeySet()
      Checks if numericKey is set or not.
      void setDN(java.lang.String aDN)
      Sets the DN of key.
      void setNumericKey(java.lang.Number aNumericKey)
      Sets the numericKey for the catalog entry key.
      void setSKU(java.lang.String aSKU)
      Sets the SKU of the key.
      void setStore(StoreKey sKey)
      Sets the StoreKey associated with the catalog entry key.
      java.lang.String toString()
      Gives a String presentation of this CatalogEntry Key.
      java.lang.String toXML()
      Converts the object into its corresponding XML format representation.
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        IBM copyright notice field.
        See Also:
        Constant Field Values
    • Constructor Detail

      • CatalogEntryKey

        public CatalogEntryKey()
        Default Constructor for CatalogEntryKey.
      • CatalogEntryKey

        public CatalogEntryKey(java.lang.String aDN,
                               java.lang.String aSKU)
        Constructor for CatalogEntryKey.
        Parameters:
        aDN - is a string of DN.
        aSKU - is a string representing SKU of the catalog entry key.
      • CatalogEntryKey

        public CatalogEntryKey(java.lang.String aDN,
                               java.lang.String aSKU,
                               StoreKey aStore)
        Constructor for CatalogEntryKey.
        Parameters:
        aDN - is a string of DN.
        aSKU - is a string representing SKU.
        aStore - is the key of the store which owns the catalog entry key.
    • Method Detail

      • getDN

        public java.lang.String getDN()
        Returns the DN of the catalog entry key.
        Returns:
        String representing the DN of the catalog entry key.
      • getSKU

        public java.lang.String getSKU()
        Returns the SKU of the catalog entry key.
        Returns:
        String representing the SKU of the catalog entry key.
      • getStore

        public StoreKey getStore()
        Returns the store key associated with the catalog entry key.
        Returns:
        StoreKey the store key associated with the catalog entry key.
      • toString

        public java.lang.String toString()
        Gives a String presentation of this CatalogEntry Key.
        Overrides:
        toString in class java.lang.Object
        Returns:
        String of the catalog entry key.
      • equals

        public boolean equals(java.lang.Object obj)
        Returns true if this CatalogEntry key equals to another CatalogEntry key.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        obj - Object is another catalog entry.
        Returns:
        boolean true if keys are equal; false otherwise.
      • hashCode

        public int hashCode()
        Returns the hashcode of the CatalogEntry key.
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        hashcode.
      • getNumericKey

        public java.lang.Number getNumericKey()
        Returns the numeric key associated with catalog entry key.
        Specified by:
        getNumericKey in interface NumericKey
        Returns:
        Number representing the numeric key associated with catalog entry key.
      • isNumericKeySet

        public boolean isNumericKeySet()
        Checks if numericKey is set or not.
        Specified by:
        isNumericKeySet in interface NumericKey
        Returns:
        boolean true if key is set; false otherwise.
      • setNumericKey

        public void setNumericKey(java.lang.Number aNumericKey)
        Sets the numericKey for the catalog entry key.
        Parameters:
        aNumericKey - The numericKey to set
      • setStore

        public void setStore(StoreKey sKey)
        Sets the StoreKey associated with the catalog entry key.
        Parameters:
        sKey - is a store key associated with the catalog entry key.
      • setDN

        public void setDN(java.lang.String aDN)
        Sets the DN of key.
        Parameters:
        aDN - The DN to set.
      • setSKU

        public void setSKU(java.lang.String aSKU)
        Sets the SKU of the key.
        Parameters:
        aSKU - The SKU to set.