atg.search.routing.command.search
Class Topic

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

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

SelectedTopic

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

A topic from the engine comprising a topic ID and path.

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION

Constructor Summary

Topic()

Method Summary

boolean	equals(java.lang.Object pObject)
protected void	getAttributeXML(java.lang.StringBuilder sb)
protected void	getBodyXML(java.lang.StringBuilder sb)
java.lang.String	getId() gets the topic id
java.lang.String	getPath() gets the topic's path, for example, /Topics/something
java.lang.String	getRequestTag()
void	setId(java.lang.String pId) Sets the topic id
void	setPath(java.lang.String pPath) Sets the topic's path

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

Constructor Detail

Topic

public Topic()

Method Detail

equals

public boolean equals(java.lang.Object pObject)

Overrides:

equals in class java.lang.Object

getId

public java.lang.String getId()

gets the topic id

Returns:

topic ID

setId

public void setId(java.lang.String pId)

Sets the topic id

Parameters:

pId - topic ID

getPath

public java.lang.String getPath()

gets the topic's path, for example, /Topics/something

Returns:

the topic's path

setPath

public void setPath(java.lang.String pPath)

Sets the topic's path

Parameters:

pPath - the topic's path

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