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 is used in conjunction with the Groupable interface. To evaluate whether an entity implementing the Groupable interface meets the grouping criteria specified by a group,the value that the entity returns for a given ttibute ( on which it can be grouped), it may need to know the context. An example would be to ask a user object its value for preferred currncy, the user needs the context of the store in which this evaluation is being done. This class represents the grouping context that carris the necessay context to find values for the context specific attributes.

See Also:
Serialized Form

Constructor Summary
GroupingContext()
          The constructor to create a new GroupingContext object.
 
Method Summary
 java.util.Hashtable getGroupingContextVariables()
          Returns a Hashtable that stores the name-value pairs containing the context information.
 java.lang.Integer getStoreId()
          Gets the store Id for this request.
 void setGroupingContextVariables(java.util.Hashtable newGroupingContextVariables)
          Sets the context information that is needed for the evalution of some attributes.
 void setStoreId(java.lang.Integer newValue)
          Sets the store Id associated with this command.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GroupingContext

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

getGroupingContextVariables

public java.util.Hashtable getGroupingContextVariables()
Returns a Hashtable that stores the name-value pairs containing the context information.

getStoreId

public final java.lang.Integer getStoreId()
Gets the store Id for this request.
Returns:
Integer - the store Id

setGroupingContextVariables

public void setGroupingContextVariables(java.util.Hashtable newGroupingContextVariables)
Sets the context information that is needed for the evalution of some attributes.

setStoreId

public final void setStoreId(java.lang.Integer newValue)
Sets the store Id associated with this command. This method is for internal use by the command framework only.
Parameters:
storeId - java.lang.Integer