atg.search.routing.command.search
Class ResultListControls

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

All Implemented Interfaces:

java.io.Serializable

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

Result list controls component of ResultCollection. Contains a map of controls, and a list of types.

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

ResultListControls()

Method Summary

boolean	equals(java.lang.Object pObject)
protected static ResultListControls	fromXmlParser(atg.search.routing.utils.SearchMessageNode pXml)
protected void	getBodyXML(java.lang.StringBuilder sb)
java.lang.String	getRequestTag()
java.util.Map<java.lang.String,Control>	getResultListControls() Returns the map of result list controls, where control.name is mapped to the control.
java.util.List<Control>	getResultListTypes() List of result list types
void	setResultListControls(java.util.Map<java.lang.String,Control> pResultListControls) Sets the map of result list controls, where control.name is mapped to the control.
void	setResultListTypes(java.util.List<Control> pResultListTypes) Sets List of result list types

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

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

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

ResultListControls

public ResultListControls()

Method Detail

equals

public boolean equals(java.lang.Object pObject)

Overrides:

equals in class java.lang.Object

getResultListControls

public java.util.Map<java.lang.String,Control> getResultListControls()

Returns the map of result list controls, where control.name is mapped to the control.

Returns:

map of result list controls

setResultListControls

public void setResultListControls(java.util.Map<java.lang.String,Control> pResultListControls)

Sets the map of result list controls, where control.name is mapped to the control.

Parameters:

pResultListControls - the map of result list controls, where control.name is mapped to the control.

getResultListTypes

public java.util.List<Control> getResultListTypes()

List of result list types

Returns:

List of result list types

setResultListTypes

public void setResultListTypes(java.util.List<Control> pResultListTypes)

Sets List of result list types

Parameters:

pResultListTypes - List of result list types

fromXmlParser

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

getRequestTag

public java.lang.String getRequestTag()

Specified by:

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

getBodyXML

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

Overrides:

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

Throws:

atg.search.routing.command.IncompleteCommandException