atg.search.routing.command.search
Class ConstraintDiagnostic

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

All Implemented Interfaces:

java.io.Serializable

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

Diagnostic for a single constraint (which might be an expression composed of multiple constraints)

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

ConstraintDiagnostic()

Method Summary

boolean	equals(java.lang.Object pObject)
protected static ConstraintDiagnostic	fromXmlParser(atg.search.routing.utils.FastXMLModel pXml, int pConIdx)
protected void	getAttributeXML(java.lang.StringBuilder sb)
protected void	getBodyXML(java.lang.StringBuilder sb)
DocumentSetConstraint	getConstraint() Returns the constraint expression
java.lang.String	getName() Returns the name (or source) of constraint
java.lang.String	getRequestTag() Gets the xml element tag used in the request
DiagnosticStatus	getStatus() Returns the result of the constraint on this item
void	setConstraint(DocumentSetConstraint pConstraint) Sets the constraint expression
void	setName(java.lang.String pName) Sets the name
void	setStatus(DiagnosticStatus pStatus) Sets the diagnostic status

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

ConstraintDiagnostic

public ConstraintDiagnostic()

Method Detail

equals

public boolean equals(java.lang.Object pObject)

Overrides:

equals in class java.lang.Object

getName

public java.lang.String getName()

Returns the name (or source) of constraint

Returns:

Name (or source) of constraint

setName

public void setName(java.lang.String pName)

Sets the name

Parameters:

pName -

getStatus

public DiagnosticStatus getStatus()

Returns the result of the constraint on this item

Returns:

The result of the constraint on this item

setStatus

public void setStatus(DiagnosticStatus pStatus)

Sets the diagnostic status

Parameters:

pStatus -

getConstraint

public DocumentSetConstraint getConstraint()

Returns the constraint expression

Returns:

constraint expression

setConstraint

public void setConstraint(DocumentSetConstraint pConstraint)

Sets the constraint expression

Parameters:

pConstraint -

fromXmlParser

protected static ConstraintDiagnostic fromXmlParser(atg.search.routing.utils.FastXMLModel pXml,
                                                    int pConIdx)

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