public class Grouping
extends atg.search.routing.command.SearchXMLObject
implements java.io.Serializable
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
Constructor and Description |
---|
Grouping() |
Modifier and Type | Method and Description |
---|---|
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
|
appendComplexXml, appendOptionalAttr, appendOptionalElem, appendOptionalElem, appendOptionalElem, appendOptionalValue, appendRequiredAttr, appendRequiredElem, appendRequiredElem, appendRequiredValue, getAllAttributeXML, getAllBodyXML, getDefaultXmlBytes, getParentXMLObject, getXmlPath, isPrintedFirstChild, setParentXMLObject, setPrintedFirstChild, toString, toXML, toXML
public boolean equals(java.lang.Object pObject)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public GroupingMode getMode()
public void setMode(GroupingMode pMode)
pMode
- public java.lang.String getName()
public void setName(java.lang.String pName)
pName
- public int getSetting()
public void setSetting(int pSetting)
pSetting
- public java.util.List<Group> getGroups()
public void setGroups(java.util.List<Group> pGroups)
pGroups
- protected static Grouping fromXmlParser(atg.search.routing.utils.SearchMessageNode pXml)
public java.lang.String getRequestTag()
getRequestTag
in class atg.search.routing.command.SearchXMLObject
protected void getAttributeXML(java.lang.StringBuilder sb) throws atg.search.routing.command.IncompleteCommandException
getAttributeXML
in class atg.search.routing.command.SearchXMLObject
sb
- shared bufferatg.search.routing.command.IncompleteCommandException
- if required values are missingprotected void getBodyXML(java.lang.StringBuilder sb) throws atg.search.routing.command.IncompleteCommandException
getBodyXML
in class atg.search.routing.command.SearchXMLObject
sb
- shared bufferatg.search.routing.command.IncompleteCommandException