atg.search.routing.command.search
Class RelatedResponseObjects

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

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

RelatedDocumentSets, RelatedPhraseTerms, RelatedSentenceTerms

public abstract class RelatedResponseObjects
extends atg.search.routing.command.SearchXMLObject

Related response object.

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

protected

RelatedResponseObjects(int candidates, int total)

Method Summary

boolean	equals(java.lang.Object pObject)
protected void	getAttributeXML(java.lang.StringBuilder sb)
int	getCandidates() Returns the number of candidates
int	getTotal() Returns the total number
void	setCandidates(int candidates) Sets the number of candidates
void	setTotal(int total) Sets the total number

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

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

RelatedResponseObjects

protected RelatedResponseObjects(int candidates,
                                 int total)

Method Detail

equals

public boolean equals(java.lang.Object pObject)

Overrides:

equals in class java.lang.Object

getCandidates

public int getCandidates()

Returns the number of candidates

Returns:

the number of candidates

setCandidates

public void setCandidates(int candidates)

Sets the number of candidates

Parameters:

candidates - the number of candidates

getTotal

public int getTotal()

Returns the total number

Returns:

the total number

setTotal

public void setTotal(int total)

Sets the total number

Parameters:

total - the total number

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