microsoft.exchange.webservices.data
Class ViewBase

java.lang.Object
  extended by microsoft.exchange.webservices.data.ViewBase
Direct Known Subclasses:
CalendarView, PagedView

public abstract class ViewBase
extends java.lang.Object

Represents the base view class for search operations.


Method Summary
protected abstract  java.lang.Integer getMaxEntriesReturned()
          Gets the maximum number of items or folders the search operation should return.
 PropertySet getPropertySet()
          Gets the property set.
protected  PropertySet getPropertySetOrDefault()
          Gets the property set or the default.
protected abstract  ServiceObjectType getServiceObjectType()
          Gets the type of service object this view applies to.
protected abstract  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 abstract  void internalWriteSearchSettingsToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer, Grouping groupBy)
          Writes the search settings to XML.
protected  void internalWriteViewToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer)
          Writes this view to XML.
 void setPropertySet(PropertySet propertySet)
          Sets the property set.
protected abstract  void writeAttributesToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer)
          Writes the attributes to XML.
protected abstract  void writeOrderByToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer)
          Writes OrderBy property to XML.
protected  void writeToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer, Grouping groupBy)
          Writes to XML.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

internalValidate

protected void internalValidate(microsoft.exchange.webservices.data.ServiceRequestBase request)
                         throws ServiceValidationException,
                                ServiceVersionException
Validates this view.

Parameters:
request - The request using this view.
Throws:
ServiceValidationException - the service validation exception
ServiceVersionException - the service version exception

internalWriteViewToXml

protected void internalWriteViewToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer)
                               throws ServiceXmlSerializationException,
                                      java.lang.Exception
Writes this view to XML.

Parameters:
writer - The writer
Throws:
ServiceXmlSerializationException - the service xml serialization exception
java.lang.Exception - the exception

internalWriteSearchSettingsToXml

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

Parameters:
writer - The Writer
groupBy - The group by clause.
Throws:
javax.xml.stream.XMLStreamException - the xML stream exception
ServiceXmlSerializationException - the service xml serialization exception

writeOrderByToXml

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

Parameters:
writer - The Writer
Throws:
javax.xml.stream.XMLStreamException - the xML stream exception
ServiceXmlSerializationException - the service xml serialization exception

getViewXmlElementName

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

Returns:
TheXml Element name

getMaxEntriesReturned

protected abstract java.lang.Integer getMaxEntriesReturned()
Gets the maximum number of items or folders the search operation should return.

Returns:
The maximum number of items or folders that should be returned by the search operation.

getServiceObjectType

protected abstract ServiceObjectType getServiceObjectType()
Gets the type of service object this view applies to.

Returns:
A ServiceObjectType value.

writeAttributesToXml

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

Parameters:
writer - The writer.
Throws:
ServiceXmlSerializationException - the service xml serialization exception

writeToXml

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

Parameters:
writer - The writer.
groupBy - The group by clause.
Throws:
java.lang.Exception - the exception

getPropertySetOrDefault

protected PropertySet getPropertySetOrDefault()
Gets the property set or the default.

Returns:
PropertySet

getPropertySet

public PropertySet getPropertySet()
Gets the property set. PropertySet determines which properties will be loaded on found items. If PropertySet is null, all first class properties are loaded on found items.

Returns:
the property set

setPropertySet

public void setPropertySet(PropertySet propertySet)
Sets the property set. PropertySet determines which properties will be loaded on found items. If PropertySet is null, all first class properties are loaded on found items.

Parameters:
propertySet - The property set