Package microsoft.exchange.webservices.data.search

Class PagedView

java.lang.Object

microsoft.exchange.webservices.data.search.ViewBase

microsoft.exchange.webservices.data.search.PagedView

Direct Known Subclasses:

ConversationIndexedItemView, FolderView, ItemView

public abstract class PagedView
extends ViewBase

Represents a view settings that support paging in a search operation.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PagedView(int pageSize)	Initializes a new instance of the "PagedView" class.
protected	PagedView(int pageSize, int offset)	Initializes a new instance of the "PagedView" class.
protected	PagedView(int pageSize, int offset, OffsetBasePoint offsetBasePoint)	Initializes a new instance of the "PagedView" class.

Method Summary

Modifier and Type	Method	Description
protected Integer	getMaxEntriesReturned()	Gets the maximum number of item or folder the search operation should return.
int	getOffset()	Gets the offset.
OffsetBasePoint	getOffsetBasePoint()	Gets the base point of the offset.
int	getPageSize()	Gets the maximum number of item or folder the search operation should return.
void	internalValidate(ServiceRequestBase request)	Validates this view.
protected void	internalWriteSearchSettingsToXml(EwsServiceXmlWriter writer, Grouping groupBy)	Internals the write search settings to XML.
protected void	internalWriteViewToXml(EwsServiceXmlWriter writer)	Write to XML.
void	setOffset(int offset)	Sets the offset.
void	setOffsetBasePoint(OffsetBasePoint offsetBasePoint)	Sets the base point of the offset.
void	setPageSize(int pageSize)	Sets the maximum number of item or folder the search operation should return.
void	writeOrderByToXml(EwsServiceXmlWriter writer)	Writes OrderBy property to XML.

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

getPropertySet, getPropertySetOrDefault, getServiceObjectType, getViewXmlElementName, setPropertySet, writeAttributesToXml, writeToXml

Methods inherited from class java.lang.Object

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

Constructor Detail

PagedView

protected PagedView(int pageSize)

Initializes a new instance of the "PagedView" class.

Parameters:

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

PagedView

protected PagedView(int pageSize,
                    int offset)

Initializes a new instance of the "PagedView" class.

Parameters:

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

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

PagedView

protected PagedView(int pageSize,
                    int offset,
                    OffsetBasePoint offsetBasePoint)

Initializes a new instance of the "PagedView" 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

internalWriteViewToXml

protected void internalWriteViewToXml(EwsServiceXmlWriter writer)
                               throws Exception

Write to XML.

Overrides:

internalWriteViewToXml in class ViewBase

Parameters:

writer - The Writer

Throws:

Exception - the exception

getMaxEntriesReturned

protected Integer getMaxEntriesReturned()

Gets the maximum number of item or folder the search operation should return.

Specified by:

getMaxEntriesReturned in class ViewBase

Returns:

The maximum number of item or folder that should be returned by the search operation.

internalWriteSearchSettingsToXml

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

Internals the write search settings to XML.

Specified by:

internalWriteSearchSettingsToXml in class ViewBase

Parameters:

writer - the writer

groupBy - the group by clause

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.

Specified by:

writeOrderByToXml in class ViewBase

Parameters:

writer - the writer

Throws:

XMLStreamException - the XML stream exception

ServiceXmlSerializationException - the service xml serialization exception

internalValidate

public void internalValidate(ServiceRequestBase request)
                      throws ServiceVersionException,
                             ServiceValidationException

Validates this view.

Overrides:

internalValidate in class ViewBase

Parameters:

request - The request using this view.

Throws:

ServiceVersionException - the service version exception

ServiceValidationException - the service validation exception

getPageSize

public int getPageSize()

Gets the maximum number of item or folder the search operation should return.

Returns:

the page size

setPageSize

public void setPageSize(int pageSize)

Sets the maximum number of item or folder the search operation should return.

Parameters:

pageSize - the new page size

getOffsetBasePoint

public OffsetBasePoint getOffsetBasePoint()

Gets the base point of the offset.

Returns:

the offset base point

setOffsetBasePoint

public void setOffsetBasePoint(OffsetBasePoint offsetBasePoint)

Sets the base point of the offset.

Parameters:

offsetBasePoint - the new offset base point

getOffset

public int getOffset()

Gets the offset.

Returns:

the offset

setOffset

public void setOffset(int offset)

Sets the offset.

Parameters:

offset - the new offset