com.ibm.commerce.grouping

Class GroupingContext

  • java.lang.Object
    • com.ibm.commerce.grouping.GroupingContext
  • All Implemented Interfaces:
    java.io.Serializable

    public class GroupingContext
extends java.lang.Object
implements java.io.Serializable
    This class represents the grouping context that carries the necessary context to find values for the context specific attributes. It is used in conjunction with the Groupable interface. The following is needed when evaluating whether an entity implementing the Groupable interface meets the specified grouping criteria:
    • The value the entity returns for a given attribute (on which it can be grouped).
    • The context of the given attribute (may be required).
    For example, asking a user object for its preferred currency requires the context of the store in which this evaluation is being done.
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor and Description
      GroupingContext()
      The constructor to create a new GroupingContext object.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      boolean equals(java.lang.Object aObject)
      This method returns true if the specified object is equal to this object.
      java.util.Hashtable getGroupingContextVariables()
      This method returns a Hashtable that stores the name-value pairs containing the context information.
      java.lang.Integer getStoreId()
      This method gets the store ID for this request.
      int hashCode()
      This method returns a hashCode for this object.
      void setGroupingContextVariables(java.util.Hashtable newGroupingContextVariables)
      This method sets the context information required for the evaluation of some attributes.
      void setStoreId(java.lang.Integer newValue)
      Reserved for IBM internal use.
      java.lang.String toString()
      This method converts the internal representation of this object into a String, suitable for use in forming cacheID components for the WebSphere Dynamic Cache.

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • GroupingContext

        public GroupingContext()
        The constructor to create a new GroupingContext object.

    • Method Detail

      • getGroupingContextVariables

        public java.util.Hashtable getGroupingContextVariables()
        This method returns a Hashtable that stores the name-value pairs containing the context information.
        Returns:
        Hashtable A hashtable that stores the name-value pairs containing the context information.

      • getStoreId

        public final java.lang.Integer getStoreId()
        This method gets the store ID for this request.
        Returns:
        Integer The store ID.

      • setGroupingContextVariables

        public void setGroupingContextVariables(java.util.Hashtable newGroupingContextVariables)
        This method sets the context information required for the evaluation of some attributes.
        Parameters:
        newGroupingContextVariables - The new grouping context variables.

      • setStoreId

        public final void setStoreId(java.lang.Integer newValue)
        Reserved for IBM internal use.

        This method sets the store ID associated with this command. This method is for internal use by the command framework only.

        Parameters:
        newValue - The store ID.

      • toString

        public java.lang.String toString()
        This method converts the internal representation of this object into a String, suitable for use in forming cacheID components for the WebSphere Dynamic Cache.
        Overrides:
        toString in class java.lang.Object
        Returns:
        a String representation of this object.

      • equals

        public boolean equals(java.lang.Object aObject)
        This method returns true if the specified object is equal to this object.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        aObject - the specified Object.
        Returns:
        true if the specified object is equal to this object.

      • hashCode

        public int hashCode()
        This method returns a hashCode for this object.
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        the hashCode.
Skip navigation links