Package microsoft.exchange.webservices.data.search

Class FolderView

java.lang.Object

microsoft.exchange.webservices.data.search.ViewBase

microsoft.exchange.webservices.data.search.PagedView

microsoft.exchange.webservices.data.search.FolderView

public final class FolderView
extends PagedView

Represents the view settings in a folder search operation.

Constructor Summary

Constructors

Constructor	Description
FolderView(int pageSize)	Initializes a new instance of the FolderView class.
FolderView(int pageSize, int offset)	Initializes a new instance of the FolderView class.
FolderView(int pageSize, int offset, OffsetBasePoint offsetBasePoint)	Initializes a new instance of the FolderView class.

Method Summary

Modifier and Type	Method	Description
protected ServiceObjectType	getServiceObjectType()	Gets the type of service object this view applies to.
FolderTraversal	getTraversal()	Gets the search traversal mode.
protected String	getViewXmlElementName()	Gets the name of the view XML element.
void	setTraversal(FolderTraversal traversal)	Sets the search traversal mode.
void	writeAttributesToXml(EwsServiceXmlWriter writer)	Writes the attribute to XML.

Methods inherited from class microsoft.exchange.webservices.data.search.PagedView

getMaxEntriesReturned, getOffset, getOffsetBasePoint, getPageSize, internalValidate, internalWriteSearchSettingsToXml, internalWriteViewToXml, setOffset, setOffsetBasePoint, setPageSize, writeOrderByToXml

Methods inherited from class microsoft.exchange.webservices.data.search.ViewBase

getPropertySet, getPropertySetOrDefault, setPropertySet, writeToXml

Methods inherited from class java.lang.Object

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

Constructor Detail

FolderView

public FolderView(int pageSize)

Initializes a new instance of the FolderView class.

Parameters:

pageSize - The maximum number of elements the search operation should return.

FolderView

public FolderView(int pageSize,
                  int offset)

Initializes a new instance of the FolderView class.

Parameters:

pageSize - The maximum number of elements the search operation should return.

offset - The offset of the view from the base point.

FolderView

public FolderView(int pageSize,
                  int offset,
                  OffsetBasePoint offsetBasePoint)

Initializes a new instance of the FolderView class.

Parameters:

pageSize - The maximum number of elements the search operation should return.

offset - The offset of the view from the base point.

offsetBasePoint - The base point of the offset.

Method Detail

getViewXmlElementName

protected String getViewXmlElementName()

Gets the name of the view XML element.

Specified by:

getViewXmlElementName in class ViewBase

Returns:

Xml Element name

getServiceObjectType

protected ServiceObjectType getServiceObjectType()

Gets the type of service object this view applies to.

Specified by:

getServiceObjectType in class ViewBase

Returns:

A ServiceObjectType value.

writeAttributesToXml

public void writeAttributesToXml(EwsServiceXmlWriter writer)

Writes the attribute to XML.

Specified by:

writeAttributesToXml in class ViewBase

Parameters:

writer - The writer

getTraversal

public FolderTraversal getTraversal()

Gets the search traversal mode. Defaults to FolderTraversal.Shallow.

Returns:

the traversal

setTraversal

public void setTraversal(FolderTraversal traversal)

Sets the search traversal mode. Defaults to FolderTraversal.Shallow.

Parameters:

traversal - the new traversal