atg.search.routing.command.search
Class RuleAppendix
java.lang.Object
atg.search.routing.command.SearchXMLObject
atg.search.routing.command.search.RuleAppendix
- All Implemented Interfaces:
- java.io.Serializable
public class RuleAppendix
- extends atg.search.routing.command.SearchXMLObject
- implements java.io.Serializable
Source format (syntax) of any rules referred to in the response
- See Also:
- Serialized Form
Field Summary |
static java.lang.String |
CLASS_VERSION
Class version string |
Methods inherited from class atg.search.routing.command.SearchXMLObject |
appendComplexXml, appendOptionalAttr, appendOptionalElem, appendOptionalElem, appendOptionalElem, appendRequiredAttr, appendRequiredElem, appendRequiredElem, appendRequiredValue, getAllAttributeXML, getAllBodyXML, getAttributeXML, getDefaultXmlBytes, getParentXMLObject, getXmlPath, setParentXMLObject, toString, toXML, toXML |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
CLASS_VERSION
public static java.lang.String CLASS_VERSION
- Class version string
RuleAppendix
public RuleAppendix()
equals
public boolean equals(java.lang.Object pObject)
- Overrides:
equals
in class java.lang.Object
getRules
public java.util.List<AppendixRule> getRules()
- Returns the list of exclusion rules
- Returns:
- list of exclusion rules
setRules
public void setRules(java.util.List<AppendixRule> pRules)
- Sets the list of exclusion rules
- Parameters:
pRules
- list of exclusion rules
getRule
public AppendixRule getRule(java.lang.String pName,
int pId)
- Helper method to locate a rule for a rule name-id pair.
- Parameters:
pName
- rule name. See references below.pId
- rule id. See references below.
- Returns:
- the associated appendix rule, or null if none was found
- See Also:
Result.getMoveRule()
,
Result.getMoveRuleName()
,
Result.getMoveRuleId()
,
Result.getExcludedName()
,
Result.getExcludedId()
fromXmlParser
protected static RuleAppendix fromXmlParser(atg.search.routing.utils.FastXMLModel pXml,
int pRootIdx)
getRequestTag
public java.lang.String getRequestTag()
- Specified by:
getRequestTag
in class atg.search.routing.command.SearchXMLObject
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