atg.search.routing.command.search
Class Rule

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

All Implemented Interfaces:

java.io.Serializable

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

an exclusion or positioning rule

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

Rule()

Method Summary

boolean	equals(java.lang.Object pObject)
protected static Rule	fromXmlParser(atg.search.routing.utils.SearchMessageNode pXml)
protected void	getAttributeXML(java.lang.StringBuilder sb)
protected void	getBodyXML(java.lang.StringBuilder sb)
java.util.List<ExcludedDocument>	getDocuments() Returns the list of excluded or positioned docs
int	getId() Returns the id of rule
java.lang.String	getName() Returns the name of rule
java.lang.String	getRequestTag()
int	getTotal() Returns the total for rule
void	setDocuments(java.util.List<ExcludedDocument> pDocuments) Sets list of excluded or positioned docs
void	setId(int pId) Sets the id of rule
void	setName(java.lang.String pName) Sets the name of rule
void	setTotal(int pTotal) Sets the total for rule

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

Class version string

Constructor Detail

Rule

public Rule()

Method Detail

equals

public boolean equals(java.lang.Object pObject)

Overrides:

equals in class java.lang.Object

getName

public java.lang.String getName()

Returns the name of rule

Returns:

name of rule

setName

public void setName(java.lang.String pName)

Sets the name of rule

Parameters:

pName - the name of rule

getId

public int getId()

Returns the id of rule

Returns:

id of rule

setId

public void setId(int pId)

Sets the id of rule

Parameters:

pId - the id of rule

getTotal

public int getTotal()

Returns the total for rule

Returns:

total for rule

setTotal

public void setTotal(int pTotal)

Sets the total for rule

Parameters:

pTotal - total for rule

getDocuments

public java.util.List<ExcludedDocument> getDocuments()

Returns the list of excluded or positioned docs

Returns:

list of excluded or positioned docs

setDocuments

public void setDocuments(java.util.List<ExcludedDocument> pDocuments)

Sets list of excluded or positioned docs

Parameters:

pDocuments - list of excluded or positioned docs

fromXmlParser

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

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