microsoft.exchange.webservices.data.search

Class ConversationIndexedItemView

java.lang.Object

microsoft.exchange.webservices.data.search.ViewBase

microsoft.exchange.webservices.data.search.PagedView

microsoft.exchange.webservices.data.search.ConversationIndexedItemView

public final class ConversationIndexedItemView
extends PagedView

Represents the view settings in a folder search operation.

Constructor Summary

Constructors

Constructor and Description
ConversationIndexedItemView(int pageSize) Initializes a new instance of the class.
ConversationIndexedItemView(int pageSize, int offset) Initializes a new instance of the ItemView class.
ConversationIndexedItemView(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.
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	writeAttributesToXml(EwsServiceXmlWriter writer) Writes the attribute to XML.
void	writeOrderByToXml(EwsServiceXmlWriter writer) Writes OrderBy property to XML.
void	writeToXml(EwsServiceXmlWriter writer) Writes 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

ConversationIndexedItemView

public ConversationIndexedItemView(int pageSize)

Initializes a new instance of the class.

Parameters:

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

ConversationIndexedItemView

public ConversationIndexedItemView(int pageSize,
                                   int offset)

Initializes a new instance of the ItemView class.

Parameters:

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

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

ConversationIndexedItemView

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

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

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.

getViewXmlElementName

protected String getViewXmlElementName()

Gets the name of the view XML element.

Specified by:

getViewXmlElementName in class ViewBase

Returns:

XML element name.

internalValidate

public void internalValidate(ServiceRequestBase request)
                      throws ServiceVersionException,
                             ServiceValidationException

Validates this view.

Overrides:

internalValidate in class PagedView

Parameters:

request - The request using this view.

Throws:

ServiceVersionException - the service version exception

ServiceValidationException - the service validation exception

internalWriteSearchSettingsToXml

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

Internals the write search settings to XML.

Overrides:

internalWriteSearchSettingsToXml in class PagedView

Parameters:

writer - The writer.

groupBy - The group by.

Throws:

ServiceXmlSerializationException - the service xml serialization exception

XMLStreamException - the XML stream exception

writeOrderByToXml

public void writeOrderByToXml(EwsServiceXmlWriter writer)
                       throws ServiceXmlSerializationException,
                              XMLStreamException

Writes OrderBy property to XML.

Overrides:

writeOrderByToXml in class PagedView

Parameters:

writer - The writer

Throws:

ServiceXmlSerializationException - the service xml serialization exception

XMLStreamException - the XML stream exception

writeToXml

public void writeToXml(EwsServiceXmlWriter writer)
                throws Exception

Writes to XML.

Parameters:

writer - The writer

Throws:

Exception

getOrderBy

public OrderByCollection getOrderBy()

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