atg.search.routing.command.search
Class Control

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

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

Type

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

A result list control and its result

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

Control()

Method Summary

boolean	equals(java.lang.Object pObject)
protected static Control	fromXmlParser(atg.search.routing.utils.SearchMessageNode pXml)
protected void	getAttributeXML(java.lang.StringBuilder sb) Override to provide attributes.
protected void	getBodyXML(java.lang.StringBuilder sb) Override to provide the body of the xml.
java.lang.String	getCompare()
java.lang.String	getName()
java.lang.String	getRequestTag() Gets the xml element tag used in the request
int	getSetting()
DiagnosticStatus	getStatus() Returns the diagnostic status
java.lang.String	getValue()
void	setCompare(java.lang.String pCompare)
void	setName(java.lang.String pName)
void	setSetting(int pSetting)
void	setStatus(DiagnosticStatus pStatus) Sets the diagnostic status
void	setValue(java.lang.String pValue)

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

Control

public Control()

Method Detail

equals

public boolean equals(java.lang.Object pObject)

Overrides:

equals in class java.lang.Object

getStatus

public DiagnosticStatus getStatus()

Returns the diagnostic status

Returns:

diagnostic status

setStatus

public void setStatus(DiagnosticStatus pStatus)

Sets the diagnostic status

Parameters:

pStatus -

getName

public java.lang.String getName()

Returns:

name of control

setName

public void setName(java.lang.String pName)

getSetting

public int getSetting()

Returns:

configuration value

setSetting

public void setSetting(int pSetting)

getCompare

public java.lang.String getCompare()

Returns:

Comparison operator between system value and configuration setting

setCompare

public void setCompare(java.lang.String pCompare)

getValue

public java.lang.String getValue()

Returns:

system value

setValue

public void setValue(java.lang.String pValue)

fromXmlParser

protected static Control 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

Override to provide attributes.

Overrides:

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

Parameters:

sb - shared buffer

Throws:

atg.search.routing.command.IncompleteCommandException - if required values are missing

getBodyXML

protected void getBodyXML(java.lang.StringBuilder sb)
                   throws atg.search.routing.command.IncompleteCommandException

Override to provide the body of the xml. Do not include the main element tag.

Overrides:

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

Parameters:

sb - shared buffer

Throws:

atg.search.routing.command.IncompleteCommandException