microsoft.exchange.webservices.data
Class SearchFilter

java.lang.Object
  microsoft.exchange.webservices.data.ComplexProperty
      microsoft.exchange.webservices.data.SearchFilter

Direct Known Subclasses:

SearchFilter.Not, SearchFilter.PropertyBasedFilter, SearchFilter.SearchFilterCollection

public abstract class SearchFilter
extends ComplexProperty

Represents the base search filter class. Use descendant search filter classes such as SearchFilter.IsEqualTo, SearchFilter.ContainsSubstring and SearchFilter.SearchFilterCollection to define search filters.

Nested Class Summary

static class	SearchFilter.ContainsSubstring Represents a search filter that checks for the presence of a substring inside a text property.
static class	SearchFilter.ExcludesBitmask Represents a bitmask exclusion search filter.
static class	SearchFilter.Exists Represents a search filter checking if a field is set.
static class	SearchFilter.IsEqualTo Represents a search filter that checks if a property is equal to a given value or other property.
static class	SearchFilter.IsGreaterThan Represents a search filter that checks if a property is greater than a given value or other property.
static class	SearchFilter.IsGreaterThanOrEqualTo Represents a search filter that checks if a property is greater than or equal to a given value or other property.
static class	SearchFilter.IsLessThan Represents a search filter that checks if a property is less than a given value or other property.
static class	SearchFilter.IsLessThanOrEqualTo Represents a search filter that checks if a property is less than or equal to a given value or other property.
static class	SearchFilter.IsNotEqualTo Represents a search filter that checks if a property is not equal to a given value or other property.
static class	SearchFilter.Not Represents a search filter that negates another.
static class	SearchFilter.PropertyBasedFilter Represents a search filter where an item or folder property is involved.
static class	SearchFilter.RelationalFilter Represents the base class for relational filters (for example, IsEqualTo, IsGreaterThan or IsLessThanOrEqualTo).
static class	SearchFilter.SearchFilterCollection Represents a collection of search filters linked by a logical operator.

Constructor Summary

protected

SearchFilter() Initializes a new instance of the SearchFilter class.

Method Summary

protected abstract String	getXmlElementName() * Gets the name of the XML element.
protected static SearchFilter	loadFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader) * Loads from XML.
protected void	writeToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer) * Writes to XML.

Methods inherited from class microsoft.exchange.webservices.data.ComplexProperty

addOnChangeEvent, canSetFieldValue, changed, clearChangeEvents, clearChangeLog, getNamespace, internalValidate, loadFromXml, loadFromXml, readAttributesFromXml, readTextValueFromXml, removeChangeEvent, setNamespace, tryReadElementFromXml, validate, writeAttributesToXml, writeElementsToXml, writeToXml, writeToXml

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchFilter

protected SearchFilter()

Initializes a new instance of the SearchFilter class.

Method Detail

loadFromXml

protected static SearchFilter loadFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader)
                                   throws Exception

* Loads from XML.

Parameters:

reader - the reader

Returns:

SearchFilter

Throws:

Exception - the exception

getXmlElementName

protected abstract String getXmlElementName()

* Gets the name of the XML element.

Returns:

the xml element name

writeToXml

protected void writeToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer)
                   throws Exception

* Writes to XML.

Parameters:

writer - the writer

Throws:

Exception - the exception