Package microsoft.exchange.webservices.data.property.complex

Class SearchFolderParameters

java.lang.Object

microsoft.exchange.webservices.data.property.complex.ComplexProperty

microsoft.exchange.webservices.data.property.complex.SearchFolderParameters

All Implemented Interfaces:

ISelfValidate, ComplexFunctionDelegate<EwsServiceXmlReader>, IComplexPropertyChangedDelegate

public final class SearchFolderParameters
extends ComplexProperty
implements IComplexPropertyChangedDelegate

Represents the parameters associated with a search folder.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	complexPropertyChanged(ComplexProperty complexProperty)	Complex property changed.
FolderIdCollection	getRootFolderIds()	Gets the list of root folder 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.
void	readAttributesFromXml(EwsServiceXmlReader reader)	Reads the attribute from XML.
void	setSearchFilter(SearchFilter searchFilter)	Sets the search filter.
void	setTraversal(SearchFolderTraversal traversal)	Sets the traversal.
boolean	tryReadElementFromXml(EwsServiceXmlReader reader)	Tries to read element from XML.
void	validate()	Validates this instance.
void	writeAttributesToXml(EwsServiceXmlWriter writer)	Writes the attribute to XML.
void	writeElementsToXml(EwsServiceXmlWriter writer)	Writes elements to XML.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchFolderParameters

public SearchFolderParameters()

Initializes a new instance of the SearchFolderParameters class.

Method Detail

complexPropertyChanged

public void complexPropertyChanged(ComplexProperty complexProperty)

Complex property changed.

Specified by:

complexPropertyChanged in interface IComplexPropertyChangedDelegate

Parameters:

complexProperty - the complex property

tryReadElementFromXml

public boolean tryReadElementFromXml(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

public void readAttributesFromXml(EwsServiceXmlReader reader)
                           throws Exception

Reads the attribute from XML.

Overrides:

readAttributesFromXml in class ComplexProperty

Parameters:

reader - the reader

Throws:

Exception - the exception

writeAttributesToXml

public void writeAttributesToXml(EwsServiceXmlWriter writer)
                          throws ServiceXmlSerializationException

Writes the attribute to XML.

Overrides:

writeAttributesToXml in class ComplexProperty

Parameters:

writer - the writer

Throws:

ServiceXmlSerializationException - the service xml serialization exception

writeElementsToXml

public void writeElementsToXml(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.

Specified by:

validate in interface ISelfValidate

Overrides:

validate in class ComplexProperty

Throws:

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 folder 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