Class CalendarView
- java.lang.Object
-
- microsoft.exchange.webservices.data.search.ViewBase
-
- microsoft.exchange.webservices.data.search.CalendarView
-
public final class CalendarView extends ViewBase
Represents a date range view of appointments in calendar folder search operations.
-
-
Constructor Summary
Constructors Constructor Description CalendarView(Date startDate, Date endDate)Initializes a new instance of CalendarView.CalendarView(Date startDate, Date endDate, int maxItemsReturned)Initializes a new instance of CalendarView.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DategetEndDate()Gets the end date.protected IntegergetMaxEntriesReturned()Gets the maximum number of item or folder the search operation should return.IntegergetMaxItemsReturned()The maximum number of item the search operation should return.protected ServiceObjectTypegetServiceObjectType()Gets the type of service object this view applies to.DategetStartDate()Gets the start date.ItemTraversalgetTraversal()Gets the search traversal mode.protected StringgetViewXmlElementName()Gets the name of the view XML element.voidinternalValidate(ServiceRequestBase request)Validate instance.protected voidinternalWriteSearchSettingsToXml(EwsServiceXmlWriter writer, Grouping groupBy)Writes the search settings to XML.protected voidinternalWriteViewToXml(EwsServiceXmlWriter writer)Write to XML.voidsetEndDate(Date endDate)Sets the end date.voidsetMaxItemsReturned(Integer maxItemsReturned)Sets the max item returned.voidsetStartDate(Date startDate)Sets the start date.voidsetTraversal(ItemTraversal traversal)Sets the traversal.voidwriteAttributesToXml(EwsServiceXmlWriter writer)Writes the attribute to XML.voidwriteOrderByToXml(EwsServiceXmlWriter writer)Writes OrderBy property to XML.-
Methods inherited from class microsoft.exchange.webservices.data.search.ViewBase
getPropertySet, getPropertySetOrDefault, setPropertySet, writeToXml
-
-
-
-
Constructor Detail
-
CalendarView
public CalendarView(Date startDate, Date endDate)
Initializes a new instance of CalendarView.- Parameters:
startDate- the start dateendDate- the end date
-
CalendarView
public CalendarView(Date startDate, Date endDate, int maxItemsReturned)
Initializes a new instance of CalendarView.- Parameters:
startDate- the start dateendDate- the end datemaxItemsReturned- the max item returned
-
-
Method Detail
-
writeAttributesToXml
public void writeAttributesToXml(EwsServiceXmlWriter writer) throws ServiceXmlSerializationException
Writes the attribute to XML.- Specified by:
writeAttributesToXmlin classViewBase- Parameters:
writer- the writer- Throws:
ServiceXmlSerializationException- the service xml serialization exception
-
internalWriteSearchSettingsToXml
protected void internalWriteSearchSettingsToXml(EwsServiceXmlWriter writer, Grouping groupBy)
Writes the search settings to XML.- Specified by:
internalWriteSearchSettingsToXmlin classViewBase- Parameters:
writer- the writergroupBy- the group by
-
writeOrderByToXml
public void writeOrderByToXml(EwsServiceXmlWriter writer)
Writes OrderBy property to XML.- Specified by:
writeOrderByToXmlin classViewBase- Parameters:
writer- the writer
-
getServiceObjectType
protected ServiceObjectType getServiceObjectType()
Gets the type of service object this view applies to.- Specified by:
getServiceObjectTypein classViewBase- Returns:
- A ServiceObjectType value.
-
internalValidate
public void internalValidate(ServiceRequestBase request) throws ServiceVersionException, ServiceValidationException
Validate instance.- Overrides:
internalValidatein classViewBase- Parameters:
request- the request- Throws:
ServiceVersionException- the service version exceptionServiceValidationException- the service validation exception
-
internalWriteViewToXml
protected void internalWriteViewToXml(EwsServiceXmlWriter writer) throws Exception
Write to XML.- Overrides:
internalWriteViewToXmlin classViewBase- Parameters:
writer- the writer- Throws:
Exception- the exception
-
getViewXmlElementName
protected String getViewXmlElementName()
Gets the name of the view XML element.- Specified by:
getViewXmlElementNamein classViewBase- Returns:
- XML element name
-
getMaxEntriesReturned
protected Integer getMaxEntriesReturned()
Gets the maximum number of item or folder the search operation should return.- Specified by:
getMaxEntriesReturnedin classViewBase- Returns:
- The maximum number of item the search operation should return.
-
getStartDate
public Date getStartDate()
Gets the start date.- Returns:
- the start date
-
setStartDate
public void setStartDate(Date startDate)
Sets the start date.- Parameters:
startDate- the new start date
-
getEndDate
public Date getEndDate()
Gets the end date.- Returns:
- the end date
-
setEndDate
public void setEndDate(Date endDate)
Sets the end date.- Parameters:
endDate- the new end date
-
getMaxItemsReturned
public Integer getMaxItemsReturned()
The maximum number of item the search operation should return.- Returns:
- the max item returned
-
setMaxItemsReturned
public void setMaxItemsReturned(Integer maxItemsReturned) throws ArgumentException
Sets the max item returned.- Parameters:
maxItemsReturned- the new max item 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
-
-