microsoft.exchange.webservices.data.search
Class ViewBase

java.lang.Object
  microsoft.exchange.webservices.data.search.ViewBase

Direct Known Subclasses:

CalendarView, PagedView

public abstract class ViewBase
extends Object

Represents the base view class for search operations.

Method Summary

protected abstract Integer	getMaxEntriesReturned() Gets the maximum number of item or folder the search operation should return.
PropertySet	getPropertySet() Gets the property set.
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 String	getViewXmlElementName() Gets the name of the view XML element.
void	internalValidate(ServiceRequestBase request) Validates this view.
protected abstract void	internalWriteSearchSettingsToXml(EwsServiceXmlWriter writer, Grouping groupBy) Writes the search settings to XML.
protected void	internalWriteViewToXml(EwsServiceXmlWriter writer) Writes this view to XML.
void	setPropertySet(PropertySet propertySet) Sets the property set.
abstract void	writeAttributesToXml(EwsServiceXmlWriter writer) Writes the attribute to XML.
abstract void	writeOrderByToXml(EwsServiceXmlWriter writer) Writes OrderBy property to XML.
void	writeToXml(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

public void internalValidate(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(EwsServiceXmlWriter writer)
                               throws ServiceXmlSerializationException,
                                      Exception

Writes this view to XML.

Parameters:

writer - The writer

Throws:

ServiceXmlSerializationException - the service xml serialization exception

Exception - the exception

internalWriteSearchSettingsToXml

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

Writes the search settings to XML.

Parameters:

writer - the writer

groupBy - the group by clause

Throws:

XMLStreamException - the XML stream exception

ServiceXmlSerializationException - the service xml serialization exception

writeOrderByToXml

public abstract void writeOrderByToXml(EwsServiceXmlWriter writer)
                                throws XMLStreamException,
                                       ServiceXmlSerializationException

Writes OrderBy property to XML.

Parameters:

writer - the writer

Throws:

XMLStreamException - the XML stream exception

ServiceXmlSerializationException - the service xml serialization exception

getViewXmlElementName

protected abstract String getViewXmlElementName()

Gets the name of the view XML element.

Returns:

TheXml Element name

getMaxEntriesReturned

protected abstract Integer getMaxEntriesReturned()

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

Returns:

The maximum number of item or folder 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

public abstract void writeAttributesToXml(EwsServiceXmlWriter writer)
                                   throws ServiceXmlSerializationException

Writes the attribute to XML.

Parameters:

writer - The writer.

Throws:

ServiceXmlSerializationException - the service xml serialization exception

writeToXml

public void writeToXml(EwsServiceXmlWriter writer,
                       Grouping groupBy)
                throws Exception

Writes to XML.

Parameters:

writer - The writer.

groupBy - The group by clause.

Throws:

Exception - the exception

getPropertySetOrDefault

public PropertySet getPropertySetOrDefault()

Gets the property set or the default.

Returns:

PropertySet

getPropertySet

public PropertySet getPropertySet()

Gets the property set. PropertySet determines which property will be loaded on found item. If PropertySet is null, all first class property are loaded on found item.

Returns:

the property set

setPropertySet

public void setPropertySet(PropertySet propertySet)

Sets the property set. PropertySet determines which property will be loaded on found item. If PropertySet is null, all first class property are loaded on found item.

Parameters:

propertySet - The property set