atg.search.routing.command.search
Class BaseValidation

java.lang.Object
  extended by atg.search.routing.command.SearchXMLObject
      extended by atg.search.routing.command.search.BaseValidation
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
ActiveSentenceZoneValidation, ActiveSolutionZoneValidation, ContextValidation, DocSortPropValidation, fNValidation, oNsNfNValidation, oNValidation, PoolNValidation, PropValidation, RankConfigValidation, RankFormulaValidation, RefineConfigValidation, RefineElementValidation, RuleModeValidation, SetValidation, sNValidation, SortPropValidation, TargetLanguageValidation, tNValidation

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

validation type

See Also:
Serialized Form

Field Summary
static java.lang.String CLASS_VERSION
          Class version string
 
Constructor Summary
BaseValidation()
           
 
Method Summary
 boolean equals(java.lang.Object pObject)
           
protected  void fromXmlParser(atg.search.routing.utils.SearchMessageNode pXml)
           
protected  void getAttributeXML(java.lang.StringBuilder sb)
           
protected  void getBodyXML(java.lang.StringBuilder sb)
           
 java.lang.String getCorrect()
          Returns the possible corrected value of the request attribute or parameter, in case of a 'fail' status
 int getId()
          Returns the id of the validation type
 DiagnosticStatus getStatus()
          Returns the diagnostic status
 java.lang.String getType()
          Returns th type of validation, as determined by its tag.
 java.lang.String getValue()
          Returns the current value of the request attribute or parameter
 void setCorrect(java.lang.String pCorrect)
          Sets the possible corrected value of the request attribute or parameter, in case of a 'fail' status
 void setId(int pId)
          Sets the id of the validation type
 void setStatus(DiagnosticStatus pStatus)
          Sets the status
 void setValue(java.lang.String pValue)
          Sets the current value of the request attribute or parameter
 
Methods inherited from class atg.search.routing.command.SearchXMLObject
appendComplexXml, appendOptionalAttr, appendOptionalElem, appendOptionalElem, appendOptionalElem, appendOptionalValue, appendRequiredAttr, appendRequiredElem, appendRequiredElem, appendRequiredValue, getAllAttributeXML, getAllBodyXML, getDefaultXmlBytes, getParentXMLObject, getRequestTag, 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

BaseValidation

public BaseValidation()
Method Detail

equals

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

getType

public java.lang.String getType()
Returns th type of validation, as determined by its tag. This is not a property of the XML.

Returns:
the validation tag

getStatus

public DiagnosticStatus getStatus()
Returns the diagnostic status

Returns:
diagnostic status

setStatus

public void setStatus(DiagnosticStatus pStatus)
Sets the status

Parameters:
pStatus -

getId

public int getId()
Returns the id of the validation type

Returns:
ID of the validation type

setId

public void setId(int pId)
Sets the id of the validation type

Parameters:
pId -

getValue

public java.lang.String getValue()
Returns the current value of the request attribute or parameter

Returns:
Current value of the request attribute or parameter

setValue

public void setValue(java.lang.String pValue)
Sets the current value of the request attribute or parameter

Parameters:
pValue -

getCorrect

public java.lang.String getCorrect()
Returns the possible corrected value of the request attribute or parameter, in case of a 'fail' status

Returns:
Possible corrected value of the request attribute or parameter, in case of a 'fail' status

setCorrect

public void setCorrect(java.lang.String pCorrect)
Sets the possible corrected value of the request attribute or parameter, in case of a 'fail' status

Parameters:
pCorrect -

fromXmlParser

protected void fromXmlParser(atg.search.routing.utils.SearchMessageNode pXml)

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