Package microsoft.exchange.webservices.data.core.service.folder

Class CalendarFolder

java.lang.Object

microsoft.exchange.webservices.data.core.service.ServiceObject

microsoft.exchange.webservices.data.core.service.folder.Folder

microsoft.exchange.webservices.data.core.service.folder.CalendarFolder

public class CalendarFolder
extends Folder

Represents a folder containing appointments.

Constructor Summary

Constructors

Constructor	Description
CalendarFolder(ExchangeService service)	Initializes an unsaved local instance of "CalendarFolder".

Method Summary

Modifier and Type	Method	Description
static CalendarFolder	bind(ExchangeService service, WellKnownFolderName name)	Binds to an existing calendar folder and loads the specified set of property.
static CalendarFolder	bind(ExchangeService service, WellKnownFolderName name, PropertySet propertySet)	Binds to an existing calendar folder and loads the specified set of property.
static CalendarFolder	bind(ExchangeService service, FolderId id)	Binds to an existing calendar folder and loads the specified set of property.
static CalendarFolder	bind(ExchangeService service, FolderId id, PropertySet propertySet)	Binds to an existing calendar folder and loads the specified set of property.
FindItemsResults<Appointment>	findAppointments(CalendarView view)	Obtains a list of appointments by searching the contents of this folder and performing recurrence expansion for recurring appointments.
ExchangeVersion	getMinimumRequiredServerVersion()	Obtains a list of appointments by searching the contents of this folder and performing recurrence expansion.

Methods inherited from class microsoft.exchange.webservices.data.core.service.folder.Folder

copy, copy, delete, empty, findFolders, findFolders, findItems, findItems, findItems, findItems, findItems, findItems, getChangeXmlElementName, getChildFolderCount, getDeleteFieldXmlElementName, getDisplayName, getEffectiveRights, getExtendedProperties, getExtendedPropertiesForService, getFolderClass, getId, getIdPropertyDefinition, getManagedFolderInformation, getParentFolderId, getPermissions, getSchema, getSetFieldXmlElementName, getTotalCount, getUnreadCount, getWellKnownFolderName, internalDelete, internalLoad, move, move, removeExtendedProperty, save, save, setDisplayName, setExtendedProperty, setFolderClass, update, validate

Methods inherited from class microsoft.exchange.webservices.data.core.service.ServiceObject

addServiceObjectChangedEvent, changed, clearChangeLog, clearServiceObjectChangedEvent, getIsCustomDateTimeScopingRequired, getIsTimeZoneHeaderRequired, getLoadedPropertyDefinitions, getObjectFromPropertyDefinition, getPropertyBag, getService, getXmlElementName, getXmlElementNameOverride, isDirty, isNew, load, load, loadFromXml, loadFromXml, removeServiceObjectChangedEvent, schema, setService, throwIfThisIsNew, throwIfThisIsNotNew, tryGetExtendedProperty, tryGetProperty, tryGetProperty, writeToXml, writeToXmlForUpdate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CalendarFolder

public CalendarFolder(ExchangeService service)
               throws Exception

Initializes an unsaved local instance of "CalendarFolder". To bind to an existing calendar folder, use CalendarFolder.Bind() instead. Calling this method results in a call to EWS.

Parameters:

service - the service

Throws:

Exception - the exception

Method Detail

bind

public static CalendarFolder bind(ExchangeService service,
                                  FolderId id,
                                  PropertySet propertySet)
                           throws Exception

Binds to an existing calendar folder and loads the specified set of property. Calling this method results in a call to EWS.

Parameters:

service - the service

id - the id

propertySet - the property set

Returns:

A CalendarFolder instance representing the calendar folder corresponding to the specified Id

Throws:

Exception - the exception

bind

public static CalendarFolder bind(ExchangeService service,
                                  FolderId id)
                           throws Exception

Binds to an existing calendar folder and loads the specified set of property. Calling this method results in a call to EWS.

Parameters:

service - the service

id - the id

Returns:

A CalendarFolder instance representing the calendar folder corresponding to the specified Id

Throws:

Exception - the exception

bind

public static CalendarFolder bind(ExchangeService service,
                                  WellKnownFolderName name,
                                  PropertySet propertySet)
                           throws Exception

Binds to an existing calendar folder and loads the specified set of property. Calling this method results in a call to EWS.

Parameters:

service - the service

name - the name

propertySet - the property set

Returns:

A CalendarFolder instance representing the calendar folder with the specified name.

Throws:

Exception - the exception

bind

public static CalendarFolder bind(ExchangeService service,
                                  WellKnownFolderName name)
                           throws Exception

Binds to an existing calendar folder and loads the specified set of property. Calling this method results in a call to EWS.

Parameters:

service - the service

name - the name

Returns:

A CalendarFolder instance representing the calendar folder with the specified name.

Throws:

Exception - the exception

findAppointments

public FindItemsResults<Appointment> findAppointments(CalendarView view)
                                               throws Exception

Obtains a list of appointments by searching the contents of this folder and performing recurrence expansion for recurring appointments. Calling this method results in a call to EWS.

Parameters:

view - the view

Returns:

An object representing the results of the search operation.

Throws:

Exception - the exception

getMinimumRequiredServerVersion

public ExchangeVersion getMinimumRequiredServerVersion()

Obtains a list of appointments by searching the contents of this folder and performing recurrence expansion.

Overrides:

getMinimumRequiredServerVersion in class Folder

Returns:

Earliest Exchange version in which this service object type is supported.