atg.search.routing.command.search
Class Limit

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

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

item retrieval limit

See Also:
Serialized Form

Field Summary
static java.lang.String CLASS_VERSION
          Class version string
 
Constructor Summary
Limit()
           
 
Method Summary
 boolean equals(java.lang.Object pObject)
           
protected static Limit fromXmlParser(atg.search.routing.utils.SearchMessageNode pXml)
           
protected  void getAttributeXML(java.lang.StringBuilder sb)
           
protected  void getBodyXML(java.lang.StringBuilder sb)
           
 java.lang.String getCompare()
          Returns the comparison operator between system value and configuration setting
 java.lang.String getName()
          Returns the name of the setting
 java.lang.String getRequestTag()
          Gets the xml element tag used in the request
 int getSetting()
          Returns the configuration value
 DiagnosticStatus getStatus()
          Returns the status of the limit
 java.lang.String getValue()
          Returns the system value
 void setCompare(java.lang.String pCompare)
          Sets the comparison operator between system value and configuration setting
 void setName(java.lang.String pName)
          Sets name of setting
 void setSetting(int pSetting)
          Sets the configuration value
 void setStatus(DiagnosticStatus pStatus)
          Sets the status
 void setValue(java.lang.String pValue)
          Sets the system 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, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION
Class version string

Constructor Detail

Limit

public Limit()
Method Detail

equals

public boolean equals(java.lang.Object pObject)
Overrides:
equals in class java.lang.Object

getStatus

public DiagnosticStatus getStatus()
Returns the status of the limit

Returns:
status

setStatus

public void setStatus(DiagnosticStatus pStatus)
Sets the status

Parameters:
pStatus -

getName

public java.lang.String getName()
Returns the name of the setting

Returns:
name of setting

setName

public void setName(java.lang.String pName)
Sets name of setting

Parameters:
pName -

getSetting

public int getSetting()
Returns the configuration value

Returns:
configuration value

setSetting

public void setSetting(int pSetting)
Sets the configuration value

Parameters:
pSetting -

getCompare

public java.lang.String getCompare()
Returns the comparison operator between system value and configuration setting

Returns:
Comparison operator between system value and configuration setting

setCompare

public void setCompare(java.lang.String pCompare)
Sets the comparison operator between system value and configuration setting

Parameters:
pCompare -

getValue

public java.lang.String getValue()
Returns the system value

Returns:
system value

setValue

public void setValue(java.lang.String pValue)
Sets the system value

Parameters:
pValue - System value

fromXmlParser

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

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