atg.search.routing.command.search
Class ResultCollection

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

All Implemented Interfaces:

java.io.Serializable

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

The result collection step of the ItemTrace. Step 4: Result collection and grouping

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

ResultCollection()

Method Summary

boolean	equals(java.lang.Object pObject)
protected static ResultCollection	fromXmlParser(atg.search.routing.utils.SearchMessageNode pXml)
protected void	getAttributeXML(java.lang.StringBuilder sb)
protected void	getBodyXML(java.lang.StringBuilder sb)
Grouping	getGrouping() Returns the result grouping activity
int	getPageSize() Returns the size of result page
Pool	getPool() Returns the application of the candidate pool limit (poolN)
java.lang.String	getRequestTag()
ResultListControls	getResultListControls() Returns result list controls
void	setGrouping(Grouping pGrouping) Sets the Result grouping activity
void	setPageSize(int pPageSize) Sets the size of result page
void	setPool(Pool pPool) Sets the application of the candidate pool limit (poolN)
void	setResultListControls(ResultListControls pResultListControls) Sets result list controls

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, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

ResultCollection

public ResultCollection()

Method Detail

equals

public boolean equals(java.lang.Object pObject)

Overrides:

equals in class java.lang.Object

getPageSize

public int getPageSize()

Returns the size of result page

Returns:

size of result page

setPageSize

public void setPageSize(int pPageSize)

Sets the size of result page

Parameters:

pPageSize - size of result page

getPool

public Pool getPool()

Returns the application of the candidate pool limit (poolN)

Returns:

The application of the candidate pool limit (poolN)

setPool

public void setPool(Pool pPool)

Sets the application of the candidate pool limit (poolN)

Parameters:

pPool - the application of the candidate pool limit (poolN)

getResultListControls

public ResultListControls getResultListControls()

Returns result list controls

Returns:

result list controls

setResultListControls

public void setResultListControls(ResultListControls pResultListControls)

Sets result list controls

Parameters:

pResultListControls - result list controls

getGrouping

public Grouping getGrouping()

Returns the result grouping activity

Returns:

Result grouping activity

setGrouping

public void setGrouping(Grouping pGrouping)

Sets the Result grouping activity

Parameters:

pGrouping - Result grouping activity

fromXmlParser

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

getRequestTag

public java.lang.String getRequestTag()

Specified by:

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

getAttributeXML

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

Overrides:

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

Throws:

atg.search.routing.command.IncompleteCommandException

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