com.ibm.commerce.marketing.promotion.dependency

Class OrderKey

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

    public class OrderKey
extends java.lang.Object
implements XMLizable, NumericKey
    The OrderKey class represents the key for an order.

    XML Snippet for OrderKey: 

      <OrderKey>
        <OrderId>1234</OrderId>
  </OrderKey>
    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
      OrderKey()
      Default Constructor for OrderKey.
      OrderKey(java.lang.Long anOrderId)
      Constructor for OrderKey.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      boolean equals(java.lang.Object obj)
      Returns true if this Order key equals to another Order key.
      void fromXML(org.w3c.dom.Node node)
      Transforms the XML node into its corresponding real Object.
      java.lang.Number getNumericKey()
      Returns the numericKey.
      java.lang.Long getOrderId()
      Returns the orderId.
      int hashCode()
      Returns the hashcode of the Order key.
      boolean isNumericKeySet()
      Checks if numericKey is set or not.
      void setNumericKey(java.lang.Number numericKey)
      Sets the numericKey.
      java.lang.String toString()
      Give a String presentation of this Order 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

      • OrderKey

        public OrderKey()
        Default Constructor for OrderKey.

      • OrderKey

        public OrderKey(java.lang.Long anOrderId)
        Constructor for OrderKey.
        Parameters:
        anOrderId - java.lang.Long is an order id.

    • Method Detail

      • getOrderId

        public java.lang.Long getOrderId()
        Returns the orderId.
        Returns:
        Long order id.

      • toString

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

      • equals

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

      • hashCode

        public int hashCode()
        Returns the hashcode of the Order key.
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        hashcode of the Order 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 numericKey)
        Sets the numericKey.
        Parameters:
        numericKey - The numericKey to set
Skip navigation links