atg.search.routing.command.search

Class ExcludedDocument

java.lang.Object

atg.search.routing.command.SearchXMLObject

atg.search.routing.command.search.ExcludedDocument

All Implemented Interfaces:

java.io.Serializable

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

A document listed in the rule exclusions

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

Method Summary

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	getGroup() Returns the response group number
int	getId() Returns the internal id of the document
java.lang.String	getRequestTag() Gets the xml element tag used in the request
java.lang.String	getValue() Returns the document value
int	hashCode()
void	setGroup(int pGroup) Sets the response group number
void	setId(int pId) Sets the internal id of the document
void	setValue(java.lang.String pValue) Sets the document value

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

ExcludedDocument

public ExcludedDocument()

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

getId

public int getId()

Returns the internal id of the document

Returns:

internal id of the document

setId

public void setId(int pId)

Sets the internal id of the document

Parameters:

pId -

getGroup

public int getGroup()

Returns the response group number

Returns:

response group number

setGroup

public void setGroup(int pGroup)

Sets the response group number

Parameters:

pGroup -

getValue

public java.lang.String getValue()

Returns the document value

Returns:

document value

setValue

public void setValue(java.lang.String pValue)

Sets the document value

Parameters:

pValue -

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

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