atg.search.routing.command.search
Class RequestVariables

java.lang.Object
  extended by atg.search.routing.command.SearchXMLObject
      extended by atg.search.routing.command.search.RequestVariables
All Implemented Interfaces:
java.io.Serializable

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

Represents a list of RequestVariables used in rank configs.

See Also:
Serialized Form

Field Summary
static java.lang.String CLASS_VERSION
          Class version string
 
Constructor Summary
RequestVariables()
           
 
Method Summary
protected static RequestVariables fromXmlParser(atg.search.routing.utils.SearchMessageNode xml)
          creates a new RequestVariables from the xml parser
protected  void getBodyXML(java.lang.StringBuilder sb)
           
 java.lang.String getRequestTag()
           
 atg.nucleus.ResolvingMap getVars()
          Returns the map of variables
 void setVars(atg.nucleus.ResolvingMap pVars)
          Sets the map of variables
 
Methods inherited from class atg.search.routing.command.SearchXMLObject
appendComplexXml, appendOptionalAttr, appendOptionalElem, appendOptionalElem, appendOptionalElem, appendOptionalValue, appendRequiredAttr, appendRequiredElem, appendRequiredElem, appendRequiredValue, getAllAttributeXML, getAllBodyXML, getAttributeXML, 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

RequestVariables

public RequestVariables()
Method Detail

getRequestTag

public java.lang.String getRequestTag()
Specified by:
getRequestTag in class atg.search.routing.command.SearchXMLObject

getVars

public atg.nucleus.ResolvingMap getVars()
Returns the map of variables

Returns:
the map of variables

setVars

public void setVars(atg.nucleus.ResolvingMap pVars)
Sets the map of variables

Parameters:
pVars - the map of variables

fromXmlParser

protected static RequestVariables fromXmlParser(atg.search.routing.utils.SearchMessageNode xml)
creates a new RequestVariables from the xml parser

Parameters:
xml - an xml parser
rootIdx - index for element
Returns:
a new RequestVariables initialized from the parser

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