microsoft.exchange.webservices.data
Class ItemView

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

public final class ItemView
extends PagedView

Represents the view settings in a folder search operation.


Constructor Summary
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
 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.
 ItemTraversal getTraversal()
          Gets the search traversal mode.
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.
 void setTraversal(ItemTraversal value)
          Sets the traversal.
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.
 
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

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 java.lang.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

protected void internalValidate(microsoft.exchange.webservices.data.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

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

Specified by:
writeAttributesToXml in class ViewBase
Parameters:
writer - the writer
Throws:
ServiceXmlSerializationException - the service xml serialization exception

internalWriteSearchSettingsToXml

protected void internalWriteSearchSettingsToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer,
                                                Grouping groupBy)
                                         throws javax.xml.stream.XMLStreamException,
                                                ServiceXmlSerializationException
Internals the write search settings to XML.

Overrides:
internalWriteSearchSettingsToXml in class PagedView
Parameters:
writer - the writer
groupBy - the group by
Throws:
javax.xml.stream.XMLStreamException - the xML stream exception
ServiceXmlSerializationException - the service xml serialization exception

writeOrderByToXml

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

Overrides:
writeOrderByToXml in class PagedView
Parameters:
writer - the writer
Throws:
javax.xml.stream.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 properties against which the returned items should be ordered.

Returns:
the order by