com.ibm.commerce.marketing.promotion.dependency

Class CustomerProfileKey

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


    public class CustomerProfileKey
    extends java.lang.Object
    implements NumericKey, XMLizable
    The key to represent a customer profile in the store. A CustomerProfile is composed of a Distinguished Name (DN) of the owner and the name of a customer profile.

    XML Snippet for CustomerProfileKey:

      <CustomerProfileKey>
            <OwnerDN>ou=b2c,o=seller organization,o=root organization</OwnerDN>
            <ProfileName>A Profile Name</ProfileName>
      </CustomerProfileKey>
     
    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
      CustomerProfileKey()
      Default Constructor for CustomerProfileKey.
      CustomerProfileKey(java.lang.String aOwnerDN, java.lang.String aProfileName)
      Constructor for CustomerProfileKey.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      boolean equals(java.lang.Object obj)
      Returns true if this CustomerProfile key equals to another CustomerProfile key.
      void fromXML(org.w3c.dom.Node node)
      Transforms the XML node into its corresponding real Object.
      java.lang.String getName()
      Returns the name of the customer profile key.
      java.lang.Number getNumericKey()
      Returns the numericKey of the CustomerProfile key.
      java.lang.String getOwnerDN()
      Returns the owner DN.
      int hashCode()
      Returns the hashcode of the CustomerProfile key.
      boolean isNumericKeySet()
      Checks if numericKey is set or not.
      void setName(java.lang.String aName)
      Sets the Name.
      void setNumericKey(java.lang.Number aNumericKey)
      Sets the numericKey for the customer profile key.
      void setOwnerDN(java.lang.String aOwnerDN)
      Sets the owner DN.
      java.lang.String toString()
      Gives a String presentation of this CustomerProfile 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

      • CustomerProfileKey

        public CustomerProfileKey(java.lang.String aOwnerDN,
                                  java.lang.String aProfileName)
        Constructor for CustomerProfileKey.
        Parameters:
        aOwnerDN - DN of the profile owner.
        aProfileName - The name of the profile
      • CustomerProfileKey

        public CustomerProfileKey()
        Default Constructor for CustomerProfileKey.
    • Method Detail

      • getName

        public java.lang.String getName()
        Returns the name of the customer profile key.
        Returns:
        String is the name of the customer profile key.
      • toString

        public java.lang.String toString()
        Gives a String presentation of this CustomerProfile Key.
        Overrides:
        toString in class java.lang.Object
        Returns:
        String representing this CustomerProfile Key.
      • equals

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

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

        public java.lang.Number getNumericKey()
        Returns the numericKey of the CustomerProfile key.
        Specified by:
        getNumericKey in interface NumericKey
        Returns:
        Number is the numeric key of the CustomerProfile 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 customer profile key.
        Parameters:
        aNumericKey - The numericKey to set for the customer profile key.
      • getOwnerDN

        public java.lang.String getOwnerDN()
        Returns the owner DN.
        Returns:
        owner DN.
      • setOwnerDN

        public void setOwnerDN(java.lang.String aOwnerDN)
        Sets the owner DN.
        Parameters:
        aOwnerDN - The owner DN to set.
      • setName

        public void setName(java.lang.String aName)
        Sets the Name.
        Parameters:
        aName - The Name to set.