atg.search.routing.command.search
Class ResponseTree

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

All Implemented Interfaces:

java.io.Serializable

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

The response tree appears in QueryRequest.Response, SimilarDocsRequest.Response, and StructuredQueryRequest.Response. It is a List of ResponseGroups.

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

ResponseTree()

Method Summary

boolean	equals(java.lang.Object pObject)
protected void	getBodyXML(java.lang.StringBuilder sb)
java.lang.String	getRequestTag() Gets the xml element tag used in the request
java.util.List<ResponseGroup>	getResponseGroups() Returns the List of ResponseGroup
void	setResponseGroups(java.util.List responseGroups) Sets the List of ResponseGroup

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

appendComplexXml, appendOptionalAttr, appendOptionalElem, appendOptionalElem, appendOptionalElem, appendRequiredAttr, appendRequiredElem, appendRequiredElem, appendRequiredValue, getAllAttributeXML, getAllBodyXML, getAttributeXML, getDefaultXmlBytes, getParentXMLObject, getXmlPath, setParentXMLObject, 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

ResponseTree

public ResponseTree()

Method Detail

equals

public boolean equals(java.lang.Object pObject)

Overrides:

equals in class java.lang.Object

getResponseGroups

public java.util.List<ResponseGroup> getResponseGroups()

Returns the List of ResponseGroup

Returns:

List of ResponseGroup

setResponseGroups

public void setResponseGroups(java.util.List responseGroups)

Sets the List of ResponseGroup

Parameters:

responseGroups - List of ResponseGroup

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

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