atg.search.routing.command.search
Class RelatedPhraseTerms

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

All Implemented Interfaces:

java.io.Serializable

public class RelatedPhraseTerms
extends RelatedResponseObjects

A list of RelatedPhraseTerms.

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

RelatedPhraseTerms(int candidates, int total)
Constructs a new instance

Method Summary

boolean	equals(java.lang.Object pObject)
protected void	getBodyXML(java.lang.StringBuilder sb)
java.lang.String	getRequestTag()
java.util.List<RelatedPhraseTerm>	getTerms() Returns the list of related phrase terms

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, 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

RelatedPhraseTerms

public RelatedPhraseTerms(int candidates,
                          int total)

Constructs a new instance

Parameters:

candidates -

total -

Method Detail

equals

public boolean equals(java.lang.Object pObject)

Overrides:

equals in class RelatedResponseObjects

getTerms

public java.util.List<RelatedPhraseTerm> getTerms()

Returns the list of related phrase terms

Returns:

the list of related phrase terms

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