microsoft.exchange.webservices.data
Class CalendarView

java.lang.Object
  extended by microsoft.exchange.webservices.data.ViewBase
      extended by microsoft.exchange.webservices.data.CalendarView

public final class CalendarView
extends ViewBase

Represents a date range view of appointments in calendar folder search operations.


Constructor Summary
CalendarView(java.util.Date startDate, java.util.Date endDate)
          Initializes a new instance of CalendarView.
CalendarView(java.util.Date startDate, java.util.Date endDate, int maxItemsReturned)
          Initializes a new instance of CalendarView.
 
Method Summary
 java.util.Date getEndDate()
          Gets the end date.
protected  java.lang.Integer getMaxEntriesReturned()
          Gets the maximum number of items or folders the search operation should return.
 java.lang.Integer getMaxItemsReturned()
          The maximum number of items the search operation should return.
protected  ServiceObjectType getServiceObjectType()
          Gets the type of service object this view applies to.
 java.util.Date getStartDate()
          Gets the start date.
 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)
          Validate instance.
protected  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)
          Write to XML.
 void setEndDate(java.util.Date endDate)
          Sets the end date.
 void setMaxItemsReturned(java.lang.Integer maxItemsReturned)
          Sets the max items returned.
 void setStartDate(java.util.Date startDate)
          Sets the start date.
 void setTraversal(ItemTraversal traversal)
          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.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

CalendarView

public CalendarView(java.util.Date startDate,
                    java.util.Date endDate)
Initializes a new instance of CalendarView.

Parameters:
startDate - the start date
endDate - the end date

CalendarView

public CalendarView(java.util.Date startDate,
                    java.util.Date endDate,
                    int maxItemsReturned)
Initializes a new instance of CalendarView.

Parameters:
startDate - the start date
endDate - the end date
maxItemsReturned - the max items returned
Method Detail

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)
Writes the search settings to XML.

Specified by:
internalWriteSearchSettingsToXml in class ViewBase
Parameters:
writer - the writer
groupBy - the group by

writeOrderByToXml

protected void writeOrderByToXml(microsoft.exchange.webservices.data.EwsServiceXmlWriter writer)
Writes OrderBy property to XML.

Specified by:
writeOrderByToXml in class ViewBase
Parameters:
writer - the writer

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
Validate instance.

Overrides:
internalValidate in class ViewBase
Parameters:
request - the request
Throws:
ServiceVersionException - the service version exception
ServiceValidationException - the service validation exception

internalWriteViewToXml

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

Overrides:
internalWriteViewToXml in class ViewBase
Parameters:
writer - the writer
Throws:
java.lang.Exception - the exception

getViewXmlElementName

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

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

getMaxEntriesReturned

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

Specified by:
getMaxEntriesReturned in class ViewBase
Returns:
The maximum number of items the search operation should return.

getStartDate

public java.util.Date getStartDate()
Gets the start date.

Returns:
the start date

setStartDate

public void setStartDate(java.util.Date startDate)
Sets the start date.

Parameters:
startDate - the new start date

getEndDate

public java.util.Date getEndDate()
Gets the end date.

Returns:
the end date

setEndDate

public void setEndDate(java.util.Date endDate)
Sets the end date.

Parameters:
endDate - the new end date

getMaxItemsReturned

public java.lang.Integer getMaxItemsReturned()
The maximum number of items the search operation should return.

Returns:
the max items returned

setMaxItemsReturned

public void setMaxItemsReturned(java.lang.Integer maxItemsReturned)
                         throws ArgumentException
Sets the max items returned.

Parameters:
maxItemsReturned - the new max items returned
Throws:
ArgumentException - the argument exception

getTraversal

public ItemTraversal getTraversal()
Gets the search traversal mode. Defaults to ItemTraversal.Shallow.

Returns:
the traversal

setTraversal

public void setTraversal(ItemTraversal traversal)
Sets the traversal.

Parameters:
traversal - the new traversal