microsoft.exchange.webservices.data
Class ConversationIndexedItemView

java.lang.Object
  extended by microsoft.exchange.webservices.data.ViewBase
      extended by microsoft.exchange.webservices.data.PagedView
          extended by microsoft.exchange.webservices.data.ConversationIndexedItemView

public final class ConversationIndexedItemView
extends PagedView

Represents the view settings in a folder search operation.


Constructor Summary
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
 OrderByCollection getOrderBy()
          Gets the properties against which the returned items should be ordered.
protected  ServiceObjectType getServiceObjectType()
          Gets the type of service object this view applies to.
protected  java.lang.String getViewXmlElementName()
          Gets the name of the view XML element.
protected  void internalValidate(microsoft.exchange.webservices.data.ServiceRequestBase request)
          Validates this view.
protected  void internalWriteSearchSettingsToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer, Grouping groupBy)
          Internals the write search settings to XML.
protected  void writeAttributesToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer)
          Writes the attributes to XML.
protected  void writeOrderByToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer)
          Writes OrderBy property to XML.
protected  void writeToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer)
          Writes to XML.
 
Methods inherited from class microsoft.exchange.webservices.data.PagedView
getMaxEntriesReturned, getOffset, getOffsetBasePoint, getPageSize, internalWriteViewToXml, setOffset, setOffsetBasePoint, setPageSize
 
Methods inherited from class microsoft.exchange.webservices.data.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

protected void writeAttributesToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer)
Writes the attributes to XML.

Specified by:
writeAttributesToXml in class ViewBase
Parameters:
writer - The writer.

getViewXmlElementName

protected java.lang.String getViewXmlElementName()
Gets the name of the view XML element.

Specified by:
getViewXmlElementName in class ViewBase
Returns:
XML element name.

internalValidate

protected void internalValidate(microsoft.exchange.webservices.data.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(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer,
                                                Grouping groupBy)
                                         throws ServiceXmlSerializationException,
                                                javax.xml.stream.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
javax.xml.stream.XMLStreamException - the xML stream exception

writeOrderByToXml

protected void writeOrderByToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer)
                          throws ServiceXmlSerializationException,
                                 javax.xml.stream.XMLStreamException
Writes OrderBy property to XML.

Overrides:
writeOrderByToXml in class PagedView
Parameters:
writer - The writer
Throws:
ServiceXmlSerializationException - the service xml serialization exception
javax.xml.stream.XMLStreamException - the xML stream exception

writeToXml

protected void writeToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer)
                   throws java.lang.Exception
Writes to XML.

Parameters:
writer - The writer
Throws:
java.lang.Exception

getOrderBy

public OrderByCollection getOrderBy()
Gets the properties against which the returned items should be ordered.