microsoft.exchange.webservices.data
Class SearchFolderParameters

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

public final class SearchFolderParameters
extends ComplexProperty

Represents the parameters associated with a search folder.

Constructor Summary

protected

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

Method Summary

void	complexPropertyChanged(ComplexProperty complexProperty) Complex property changed.
FolderIdCollection	getRootFolderIds() Gets the list of root folders the search folder searches in.
SearchFilter	getSearchFilter() Gets the search filter associated with the search folder.
SearchFolderTraversal	getTraversal() * Gets the traversal mode for the search folder.
protected void	readAttributesFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader) * Reads the attributes from XML.
void	setSearchFilter(SearchFilter searchFilter) Sets the search filter.
void	setTraversal(SearchFolderTraversal traversal) Sets the traversal.
protected boolean	tryReadElementFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader) * Tries to read element from XML.
void	validate() * Validates this instance.
protected void	writeAttributesToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer) * Writes the attributes to XML.
protected void	writeElementsToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer) * Writes elements to XML.

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

addOnChangeEvent, canSetFieldValue, changed, clearChangeEvents, clearChangeLog, getNamespace, internalValidate, loadFromXml, loadFromXml, readTextValueFromXml, removeChangeEvent, setNamespace, writeToXml, writeToXml

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchFolderParameters

protected SearchFolderParameters()

Initializes a new instance of the SearchFolderParameters class.

Method Detail

complexPropertyChanged

public void complexPropertyChanged(ComplexProperty complexProperty)

Complex property changed.

Parameters:

complexProperty - the complex property

tryReadElementFromXml

protected boolean tryReadElementFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader)
                                 throws Exception

* Tries to read element from XML.

Overrides:

tryReadElementFromXml in class ComplexProperty

Parameters:

reader - the reader

Returns:

True if element was read.

Throws:

Exception - the exception

readAttributesFromXml

protected void readAttributesFromXml(microsoft.exchange.webservices.data.EwsServiceXmlReader reader)
                              throws Exception

* Reads the attributes from XML.

Overrides:

readAttributesFromXml in class ComplexProperty

Parameters:

reader - the reader

Throws:

Exception - the exception

writeAttributesToXml

protected void writeAttributesToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer)
                             throws ServiceXmlSerializationException

* Writes the attributes to XML.

Overrides:

writeAttributesToXml in class ComplexProperty

Parameters:

writer - the writer

Throws:

ServiceXmlSerializationException - the service xml serialization exception

writeElementsToXml

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

* Writes elements to XML.

Overrides:

writeElementsToXml in class ComplexProperty

Parameters:

writer - the writer

Throws:

Exception - the exception

validate

public void validate()
              throws Exception

* Validates this instance.

Overrides:

validate in class ComplexProperty

Throws:

Exception

ServiceValidationException - the service validation exception

getTraversal

public SearchFolderTraversal getTraversal()

* Gets the traversal mode for the search folder.

Returns:

the traversal

setTraversal

public void setTraversal(SearchFolderTraversal traversal)

Sets the traversal.

Parameters:

traversal - the new traversal

getRootFolderIds

public FolderIdCollection getRootFolderIds()

Gets the list of root folders the search folder searches in.

Returns:

the root folder ids

getSearchFilter

public SearchFilter getSearchFilter()

Gets the search filter associated with the search folder. Available search filter classes include SearchFilter.IsEqualTo, SearchFilter.ContainsSubstring and SearchFilter.SearchFilterCollection.

Returns:

the search filter

setSearchFilter

public void setSearchFilter(SearchFilter searchFilter)

Sets the search filter.

Parameters:

searchFilter - the new search filter