atg.search.routing.command.search

Class Candidates

java.lang.Object

atg.search.routing.command.SearchXMLObject

atg.search.routing.command.search.Candidates

All Implemented Interfaces:

java.io.Serializable

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

List of retrieved statements from this item

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Constructor Summary

Constructors

Constructor and Description
Candidates()

Method Summary

Modifier and Type	Method and Description
void	addStatement(StatementCandidate pCandidate)
boolean	equals(java.lang.Object pObject)
protected static Candidates	fromXmlParser(atg.search.routing.utils.SearchMessageNode pXml)
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<StatementCandidate>	getStatements() Returns a List of retrieved statements from this item
int	hashCode()
void	setStatements(java.util.List<StatementCandidate> pStatements) Sets List of retrieved statements from this item

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

appendComplexXml, appendOptionalAttr, appendOptionalElem, appendOptionalElem, appendOptionalElem, appendOptionalValue, appendRequiredAttr, appendRequiredElem, appendRequiredElem, appendRequiredValue, getAllAttributeXML, getAllBodyXML, getAttributeXML, getDefaultXmlBytes, getParentXMLObject, getXmlPath, isPrintedFirstChild, setParentXMLObject, setPrintedFirstChild, toString, toXML, toXML

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

Candidates

public Candidates()

Method Detail

equals

public boolean equals(java.lang.Object pObject)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

addStatement

public void addStatement(StatementCandidate pCandidate)

getStatements

public java.util.List<StatementCandidate> getStatements()

Returns a List of retrieved statements from this item

Returns:

List of retrieved statements from this item

setStatements

public void setStatements(java.util.List<StatementCandidate> pStatements)

Sets List of retrieved statements from this item

Parameters:

pStatements - List of retrieved statements from this item

fromXmlParser

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

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