microsoft.exchange.webservices.data.search

Class ItemView

java.lang.Object

microsoft.exchange.webservices.data.search.ViewBase

microsoft.exchange.webservices.data.search.PagedView

microsoft.exchange.webservices.data.search.ItemView

public final class ItemView
extends PagedView

Represents the view settings in a folder search operation.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
OrderByCollection	getOrderBy() Gets the property against which the returned item should be ordered.
protected ServiceObjectType	getServiceObjectType() Gets the type of service object this view applies to.
ItemTraversal	getTraversal() Gets the search traversal mode.
protected String	getViewXmlElementName() Gets the name of the view XML element.
void	internalValidate(ServiceRequestBase request) Validates this view.
protected void	internalWriteSearchSettingsToXml(EwsServiceXmlWriter writer, Grouping groupBy) Internals the write search settings to XML.
void	setTraversal(ItemTraversal value) Sets the traversal.
void	writeAttributesToXml(EwsServiceXmlWriter writer) Writes the attribute to XML.
void	writeOrderByToXml(EwsServiceXmlWriter writer) Writes OrderBy property to XML.

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

getMaxEntriesReturned, getOffset, getOffsetBasePoint, getPageSize, internalWriteViewToXml, setOffset, setOffsetBasePoint, setPageSize

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

ItemView

public ItemView(int pageSize)

Initializes a new instance of the ItemView class.

Parameters:

pageSize - the page size

ItemView

public ItemView(int pageSize,
                int offset)

Initializes a new instance of the ItemView class.

Parameters:

pageSize - the page size

offset - the offset

ItemView

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

Initializes a new instance of the ItemView class.

Parameters:

pageSize - the page size

offset - the offset

offsetBasePoint - the offset base point

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.

internalValidate

public void internalValidate(ServiceRequestBase request)
                      throws ServiceVersionException,
                             ServiceValidationException

Validates this view.

Overrides:

internalValidate in class PagedView

Parameters:

request - the request

Throws:

ServiceVersionException - the service version exception

ServiceValidationException - the service validation exception

writeAttributesToXml

public void writeAttributesToXml(EwsServiceXmlWriter writer)
                          throws ServiceXmlSerializationException

Writes the attribute to XML.

Specified by:

writeAttributesToXml in class ViewBase

Parameters:

writer - the writer

Throws:

ServiceXmlSerializationException - the service xml serialization exception

internalWriteSearchSettingsToXml

protected void internalWriteSearchSettingsToXml(EwsServiceXmlWriter writer,
                                                Grouping groupBy)
                                         throws XMLStreamException,
                                                ServiceXmlSerializationException

Internals the write search settings to XML.

Overrides:

internalWriteSearchSettingsToXml in class PagedView

Parameters:

writer - the writer

groupBy - the group by

Throws:

XMLStreamException - the XML stream exception

ServiceXmlSerializationException - the service xml serialization exception

writeOrderByToXml

public void writeOrderByToXml(EwsServiceXmlWriter writer)
                       throws XMLStreamException,
                              ServiceXmlSerializationException

Writes OrderBy property to XML.

Overrides:

writeOrderByToXml in class PagedView

Parameters:

writer - the writer

Throws:

XMLStreamException - the XML stream exception

ServiceXmlSerializationException - the service xml serialization exception

getTraversal

public ItemTraversal getTraversal()

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

Returns:

the traversal

setTraversal

public void setTraversal(ItemTraversal value)

Sets the traversal.

Parameters:

value - the new traversal

getOrderBy

public OrderByCollection getOrderBy()

Gets the property against which the returned item should be ordered.

Returns:

the order by