atg.search.routing.command.search

Class RelatedDocset

java.lang.Object

atg.search.routing.command.SearchXMLObject

atg.search.routing.command.search.RelatedDocset

All Implemented Interfaces:

java.io.Serializable

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

A related document set, sometimes included in a Document.

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
RelatedDocset()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object pObject)
protected void	getAttributeXML(java.lang.StringBuilder sb)
protected void	getBodyXML(java.lang.StringBuilder sb)
int	getId() Returns the id of the docset
int	getNumResultsInSet() Returns the number of results in the set
java.lang.String	getPath() Returns the path
int	getRelevance() Returns the relevance
java.lang.String	getRequestTag()
java.lang.String	getType() Returns the type of the docset
int	hashCode()
void	setId(int id) Sets the id of the docset
void	setNumResultsInSet(int numResultsInSet) Sets the number of results in the set
void	setPath(java.lang.String path) Sets the path
void	setRelevance(int relevance) Sets the relevance
void	setType(java.lang.String type) Sets the type of the docset

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, notify, notifyAll, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

RelatedDocset

public RelatedDocset()

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

getPath

public java.lang.String getPath()

Returns the path

Returns:

the path

setPath

public void setPath(java.lang.String path)

Sets the path

Parameters:

path - the path

getId

public int getId()

Returns the id of the docset

Returns:

the id of the docset

setId

public void setId(int id)

Sets the id of the docset

Parameters:

id - the id of the docset

getRelevance

public int getRelevance()

Returns the relevance

Returns:

the relevance

setRelevance

public void setRelevance(int relevance)

Sets the relevance

Parameters:

relevance - the relevance

getNumResultsInSet

public int getNumResultsInSet()

Returns the number of results in the set

Returns:

the number of results in the set

setNumResultsInSet

public void setNumResultsInSet(int numResultsInSet)

Sets the number of results in the set

Parameters:

numResultsInSet - the number of results in the set

getType

public java.lang.String getType()

Returns the type of the docset

Returns:

the type of the docset

setType

public void setType(java.lang.String type)

Sets the type of the docset

Parameters:

type - the type of the docset

getRequestTag

public java.lang.String getRequestTag()

Specified by:

getRequestTag in class atg.search.routing.command.SearchXMLObject

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

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