atg.search.routing.command.search
Class Grouping

java.lang.Object
  atg.search.routing.command.SearchXMLObject
      atg.search.routing.command.search.Grouping

All Implemented Interfaces:

java.io.Serializable

public class Grouping
extends atg.search.routing.command.SearchXMLObject
implements java.io.Serializable

Result grouping activity

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

Grouping()

Method Summary

boolean	equals(java.lang.Object pObject)
protected static Grouping	fromXmlParser(atg.search.routing.utils.SearchMessageNode pXml)
protected void	getAttributeXML(java.lang.StringBuilder sb) Override to provide attributes.
protected void	getBodyXML(java.lang.StringBuilder sb) Override to provide the body of the xml.
java.util.List<Group>	getGroups() Returns the List of result groups containing the item
GroupingMode	getMode() Returns the grouping mode
java.lang.String	getName() Returns the name of per-group configuration setting
java.lang.String	getRequestTag() Gets the xml element tag used in the request
int	getSetting() Returns the configuration value
int	hashCode()
void	setGroups(java.util.List<Group> pGroups) Sets the List of result groups containing the item
void	setMode(GroupingMode pMode) Sets the grouping mode
void	setName(java.lang.String pName) Sets the name of per-group configuration setting
void	setSetting(int pSetting) Sets the configuration value

Methods inherited from class atg.search.routing.command.SearchXMLObject

appendComplexXml, appendOptionalAttr, appendOptionalElem, appendOptionalElem, appendOptionalElem, appendOptionalValue, appendRequiredAttr, appendRequiredElem, appendRequiredElem, appendRequiredValue, getAllAttributeXML, getAllBodyXML, getDefaultXmlBytes, getParentXMLObject, getXmlPath, isPrintedFirstChild, setParentXMLObject, setPrintedFirstChild, toString, toXML, toXML

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

Grouping

public Grouping()

Method Detail

equals

public boolean equals(java.lang.Object pObject)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getMode

public GroupingMode getMode()

Returns the grouping mode

Returns:

Grouping mode

setMode

public void setMode(GroupingMode pMode)

Sets the grouping mode

Parameters:

pMode -

getName

public java.lang.String getName()

Returns the name of per-group configuration setting

Returns:

Name of per-group configuration setting

setName

public void setName(java.lang.String pName)

Sets the name of per-group configuration setting

Parameters:

pName -

getSetting

public int getSetting()

Returns the configuration value

Returns:

Configuration value

setSetting

public void setSetting(int pSetting)

Sets the configuration value

Parameters:

pSetting -

getGroups

public java.util.List<Group> getGroups()

Returns the List of result groups containing the item

Returns:

List of result groups containing the item

setGroups

public void setGroups(java.util.List<Group> pGroups)

Sets the List of result groups containing the item

Parameters:

pGroups -

fromXmlParser

protected static Grouping fromXmlParser(atg.search.routing.utils.SearchMessageNode pXml)

getRequestTag

public java.lang.String getRequestTag()

Gets the xml element tag used in the request

Specified by:

getRequestTag in class atg.search.routing.command.SearchXMLObject

Returns:

xml element tag

getAttributeXML

protected void getAttributeXML(java.lang.StringBuilder sb)
                        throws atg.search.routing.command.IncompleteCommandException

Override to provide attributes.

Overrides:

getAttributeXML in class atg.search.routing.command.SearchXMLObject

Parameters:

sb - shared buffer

Throws:

atg.search.routing.command.IncompleteCommandException - if required values are missing

getBodyXML

protected void getBodyXML(java.lang.StringBuilder sb)
                   throws atg.search.routing.command.IncompleteCommandException

Override to provide the body of the xml. Do not include the main element tag.

Overrides:

getBodyXML in class atg.search.routing.command.SearchXMLObject

Parameters:

sb - shared buffer

Throws:

atg.search.routing.command.IncompleteCommandException