com.ibm.commerce.marketing.promotion.dependency

Class StoreKey

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

    public class StoreKey
extends java.lang.Object
implements NumericKey, XMLizable, com.ibm.websphere.cache.Sizeable
    StoreKey defines the key for a Store External Entity. The Key uniquely identifies the Store entity. A Distinguished Name DN and a store Identifier form the key for Store entity.

    XML Snippet for StoreKey: 

      <StoreKey>
        <DN>ou=b2c,o=seller organization,o=root organization</DN>
        <Identifier>ConsumerDirect</Identifier>
  </StoreKey>
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor and Description
      StoreKey()
      Default Constructor for StoreKey.
      StoreKey(java.lang.String aDN, java.lang.String aIdentifier)
      Constructor for StoreKey.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      boolean equals(java.lang.Object obj)
      Returns true if this Store key equals to another Store 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 store key.
      java.lang.String getIdentifier()
      Returns the Identifier of store key.
      java.lang.Number getNumericKey()
      Returns the numericKey.
      long getObjectSize()
      Returns the estimated footprint size in bytes of this object and the objects it contains.
      int hashCode()
      Returns the hashcode of the Store key.
      boolean isNumericKeySet()
      Checks if numericKey is set or not.
      void setDN(java.lang.String aDN)
      Sets the DN of store key.
      void setIdentifier(java.lang.String aIdentifier)
      Sets the Identifier of store key.
      void setNumericKey(java.lang.Number aNumericKey)
      Sets the numericKey.
      java.lang.String toString()
      Give a String presentation of this Store 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

      • NULL_ENTITY_STORE_KEY

        public static final StoreKey NULL_ENTITY_STORE_KEY
        A wildcard store key

    • Constructor Detail

      • StoreKey

        public StoreKey()
        Default Constructor for StoreKey.

      • StoreKey

        public StoreKey(java.lang.String aDN,
                java.lang.String aIdentifier)
        Constructor for StoreKey.
        Parameters:
        aDN - java.lang.String is DN of store key.
        aIdentifier - java.lang.String is the identifier of the store key.

    • Method Detail

      • getObjectSize

        public long getObjectSize()
        Returns the estimated footprint size in bytes of this object and the objects it contains.
        Specified by:
        getObjectSize in interface com.ibm.websphere.cache.Sizeable
        Returns:
        the estimated footprint size in bytes or -1 if a size cannot be determined.

      • getDN

        public java.lang.String getDN()
        Returns the DN of store key.
        Returns:
        String DN of store key.

      • setDN

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

      • setIdentifier

        public void setIdentifier(java.lang.String aIdentifier)
        Sets the Identifier of store key.
        Parameters:
        aIdentifier - The Identifier to set.

      • getIdentifier

        public java.lang.String getIdentifier()
        Returns the Identifier of store key.
        Returns:
        String the Identifier of store key.

      • toString

        public java.lang.String toString()
        Give a String presentation of this Store Key.
        Overrides:
        toString in class java.lang.Object
        Returns:
        String is a String presentation of this Store Key.

      • equals

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

      • hashCode

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

      • getNumericKey

        public java.lang.Number getNumericKey()
        Returns the numericKey.
        Specified by:
        getNumericKey in interface NumericKey
        Returns:
        Number the numericKey.

      • 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.
        Parameters:
        aNumericKey - The numericKey to set
Skip navigation links