atg.search.routing.command.search

Class DocumentSetConstraint

java.lang.Object

atg.search.routing.command.SearchXMLObject

atg.search.routing.command.search.DocumentSetConstraint

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

BaseConstraint

public abstract class DocumentSetConstraint
extends atg.search.routing.command.SearchXMLObject

A generic constraint that either holds raw XML, or else constructs a specific constraint via valueOf(String).

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION

Constructor Summary

Constructors

Constructor and Description
DocumentSetConstraint()

Method Summary

Modifier and Type	Method and Description
protected abstract DocumentSetConstraint	createFromParser(atg.search.routing.utils.SearchMessageNode pRoot)
static DocumentSetConstraint	createFromXML(atg.search.routing.utils.SearchMessageNode pXml)
protected static atg.search.routing.utils.SearchMessageParser	getParser(java.lang.String pRequestXml)
java.util.List<PropConstraint>	getPropConstraints() Returns an empty list unless overridden
abstract java.lang.String	getXml() Returns complete XML, if provided through ConstraintsGroup.
abstract void	setXml(java.lang.String pXml) Overrides subclass setter methods by allowing complete XML to be passed in.
static DocumentSetConstraint	valueOf(java.lang.String pXml) Constructs a new instance from xml

Methods inherited from class atg.search.routing.command.SearchXMLObject

appendComplexXml, appendOptionalAttr, appendOptionalElem, appendOptionalElem, appendOptionalElem, appendOptionalValue, appendRequiredAttr, appendRequiredElem, appendRequiredElem, appendRequiredValue, getAllAttributeXML, getAllBodyXML, getAttributeXML, getBodyXML, getDefaultXmlBytes, getParentXMLObject, getRequestTag, getXmlPath, isPrintedFirstChild, setParentXMLObject, setPrintedFirstChild, toString, toXML, toXML

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

See Also:

Constant Field Values

Constructor Detail

DocumentSetConstraint

public DocumentSetConstraint()

Method Detail

getPropConstraints

public java.util.List<PropConstraint> getPropConstraints()

Returns an empty list unless overridden

Returns:

empty list unless overridden

getParser

protected static atg.search.routing.utils.SearchMessageParser getParser(java.lang.String pRequestXml)

Parameters:

pXml -

Returns:

an xml parser initialized with the provided xml, or null if the xml was empty

valueOf

public static DocumentSetConstraint valueOf(java.lang.String pXml)

Constructs a new instance from xml

Parameters:

pXml -

Returns:

a new instance

createFromXML

public static DocumentSetConstraint createFromXML(atg.search.routing.utils.SearchMessageNode pXml)

setXml

public abstract void setXml(java.lang.String pXml)

Overrides subclass setter methods by allowing complete XML to be passed in. You must use ConstraintsGroup for this. No other constraint subclass will use the XML. The XML is not validated, so caller must be careful to ensure that it is correct.

Parameters:

pXml - complete XML

getXml

public abstract java.lang.String getXml()

Returns complete XML, if provided through ConstraintsGroup.

Returns:

Complete XML, if provided through ConstraintsGroup.

createFromParser

protected abstract DocumentSetConstraint createFromParser(atg.search.routing.utils.SearchMessageNode pRoot)