atg.search.routing.command.search

Class RequestVariable

java.lang.Object

atg.search.routing.command.SearchXMLObject

atg.search.routing.command.search.RequestVariable

All Implemented Interfaces:

java.io.Serializable

public class RequestVariable
extends atg.search.routing.command.SearchXMLObject

Represents a request variable used by a rank config.

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
RequestVariable()
RequestVariable(java.lang.String pName, java.lang.String pValue) Constructs a new instance with the specified name and value

Method Summary

Modifier and Type	Method and Description
protected static RequestVariable	fromXmlParser(atg.search.routing.utils.SearchMessageNode pXml) Constructs a new instance from the already-initialized parser
protected void	getAttributeXML(java.lang.StringBuilder sb)
protected void	getBodyXML(java.lang.StringBuilder sb)
java.lang.String	getName() Returns the name of the variable
java.lang.String	getRequestTag()
java.lang.String	getValue() Returns the value for the variable
void	setName(java.lang.String pName) Sets the name of the variable
void	setValue(java.lang.String pValue) Sets the value for the variable

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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

RequestVariable

public RequestVariable()

RequestVariable

public RequestVariable(java.lang.String pName,
                       java.lang.String pValue)

Constructs a new instance with the specified name and value

Parameters:

pName - name of the variable

pValue - its value

Method Detail

getRequestTag

public java.lang.String getRequestTag()

Specified by:

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

getName

public java.lang.String getName()

Returns the name of the variable

Returns:

name of the variable

setName

public void setName(java.lang.String pName)

Sets the name of the variable

Parameters:

pName - the name of the variable

getValue

public java.lang.String getValue()

Returns the value for the variable

Returns:

the value for the variable

setValue

public void setValue(java.lang.String pValue)

Sets the value for the variable

Parameters:

pValue - the value for the variable

fromXmlParser

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

Constructs a new instance from the already-initialized parser

Parameters:

pXml - parser

pChildIdx - the element's index

Returns:

new instance

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