atg.search.routing.command.search
Class AppendixRule

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

All Implemented Interfaces:

java.io.Serializable

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

A referenced rule and its source format (syntax)

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

AppendixRule()

Method Summary

boolean	equals(java.lang.Object pObject)
protected static AppendixRule	fromXmlParser(atg.search.routing.utils.FastXMLModel pXml, int pRuleIdx)
protected void	getAttributeXML(java.lang.StringBuilder sb)
protected void	getBodyXML(java.lang.StringBuilder sb)
int	getId() Returns the id of rule
java.lang.String	getName() Returns the name of rule
java.lang.String	getPath() Returns the path of rule
java.lang.String	getRequestTag() Gets the xml element tag used in the request
Source	getSource() Returns the source information about how the configuration was constructed
void	setId(int pId) Sets the id of rule
void	setName(java.lang.String pName) Sets the name of rule
void	setPath(java.lang.String pPath) Sets the path of rule
void	setSource(Source pSource) Sets the source information about how the configuration was constructed

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

appendComplexXml, appendOptionalAttr, appendOptionalElem, appendOptionalElem, appendOptionalElem, appendRequiredAttr, appendRequiredElem, appendRequiredElem, appendRequiredValue, getAllAttributeXML, getAllBodyXML, getDefaultXmlBytes, getParentXMLObject, getXmlPath, setParentXMLObject, 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

AppendixRule

public AppendixRule()

Method Detail

equals

public boolean equals(java.lang.Object pObject)

Overrides:

equals in class java.lang.Object

getPath

public java.lang.String getPath()

Returns the path of rule

Returns:

path of rule

setPath

public void setPath(java.lang.String pPath)

Sets the path of rule

Parameters:

pPath -

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 -

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 -

getSource

public Source getSource()

Returns the source information about how the configuration was constructed

Returns:

source information about how the configuration was constructed

setSource

public void setSource(Source pSource)

Sets the source information about how the configuration was constructed

Parameters:

pSource - source

fromXmlParser

protected static AppendixRule fromXmlParser(atg.search.routing.utils.FastXMLModel pXml,
                                            int pRuleIdx)

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