atg.search.routing.command.search
Class RelatedDocumentSets

java.lang.Object
  atg.search.routing.command.SearchXMLObject
      atg.search.routing.command.search.RelatedResponseObjects
          atg.search.routing.command.search.RelatedDocumentSets

All Implemented Interfaces:

java.io.Serializable

public class RelatedDocumentSets
extends RelatedResponseObjects

A list of RelatedDocumentSets.

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

RelatedDocumentSets(int candidates, int total)

Method Summary

boolean	equals(java.lang.Object pObject)
protected void	getBodyXML(java.lang.StringBuilder sb) Override to provide the body of the xml.
java.lang.String	getRequestTag() Gets the xml element tag used in the request
java.util.List<RelatedDocumentSet>	getSets() Returns the list of sets

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

getAttributeXML, getCandidates, getTotal, setCandidates, setTotal

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

appendComplexXml, appendOptionalAttr, appendOptionalElem, appendOptionalElem, appendOptionalElem, appendRequiredAttr, appendRequiredElem, appendRequiredElem, appendRequiredValue, getAllAttributeXML, getAllBodyXML, 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

RelatedDocumentSets

public RelatedDocumentSets(int candidates,
                           int total)

Method Detail

equals

public boolean equals(java.lang.Object pObject)

Overrides:

equals in class RelatedResponseObjects

getSets

public java.util.List<RelatedDocumentSet> getSets()

Returns the list of sets

Returns:

the list of sets

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

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