atg.search.routing.command.search

Class BaseConstraint

java.lang.Object

atg.search.routing.command.SearchXMLObject

atg.search.routing.command.search.DocumentSetConstraint

atg.search.routing.command.search.BaseConstraint

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

CollectionConstraint, ConstraintsGroup, DateConstraint, FileExtensionConstraint, ItemFormatConstraint, KeywordConstraint, LanguageConstraint, NumericConstraint, PropConstraint, SetConstraint, StringConstraint, URLConstraint

public abstract class BaseConstraint
extends DocumentSetConstraint

Base class for creating different type of constraint implementations.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseConstraint()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getXml() Returns complete XML, if provided through ConstraintsGroup.
void	setXml(java.lang.String pXml) Overrides subclass setter methods by allowing complete XML to be passed in.

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

createFromParser, createFromXML, getParser, getPropConstraints, valueOf

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 java.lang.String CLASS_VERSION

Class version string

Constructor Detail

BaseConstraint

protected BaseConstraint()

Method Detail

setXml

public void setXml(java.lang.String pXml)

Description copied from class: DocumentSetConstraint

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.

Specified by:

setXml in class DocumentSetConstraint

Parameters:

pXml - complete XML

getXml

public java.lang.String getXml()

Description copied from class: DocumentSetConstraint

Returns complete XML, if provided through ConstraintsGroup.

Specified by:

getXml in class DocumentSetConstraint

Returns:

Complete XML, if provided through ConstraintsGroup.