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

Class Appointment

java.lang.Object

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

microsoft.exchange.webservices.data.core.service.item.Item

microsoft.exchange.webservices.data.core.service.item.Appointment

All Implemented Interfaces:

ICalendarActionProvider

public class Appointment
extends Item
implements ICalendarActionProvider

Represents an appointment or a meeting. Properties available on appointments are defined in the AppointmentSchema class.

Constructor Summary

Constructors

Constructor	Description
Appointment(ExchangeService service)	Initializes an unsaved local instance of Appointment".
Appointment(ItemAttachment parentAttachment, boolean isNew)	Initializes a new instance of Appointment.

Method Summary

Modifier and Type	Method	Description
CalendarActionResults	accept(boolean sendResponse)	Accepts the meeting.
CalendarActionResults	acceptTentatively(boolean sendResponse)	Tentatively accepts the meeting.
static Appointment	bind(ExchangeService service, ItemId id)	Binds to an existing appointment and loads its first class property.
static Appointment	bind(ExchangeService service, ItemId id, PropertySet propertySet)	Binds to an existing appointment and loads the specified set of property.
static Appointment	bindToOccurrence(ExchangeService service, ItemId recurringMasterId, int occurenceIndex)	Binds to an existing appointment and loads its first class property.
static Appointment	bindToOccurrence(ExchangeService service, ItemId recurringMasterId, int occurenceIndex, PropertySet propertySet)	Binds to an existing appointment and loads its first class property.
static Appointment	bindToRecurringMaster(ExchangeService service, ItemId occurrenceId)	Binds to the master appointment of a recurring series and loads its first class property.
static Appointment	bindToRecurringMaster(ExchangeService service, ItemId occurrenceId, PropertySet propertySet)	Binds to the master appointment of a recurring series and loads its first class property.
CalendarActionResults	cancelMeeting()	Cancels the meeting and sends cancellation messages to all attendees.
CalendarActionResults	cancelMeeting(String cancellationMessageText)	Cancels the meeting and sends cancellation messages to all attendees.
AcceptMeetingInvitationMessage	createAcceptMessage(boolean tentative)	Creates a local meeting acceptance message that can be customized and sent.
CancelMeetingMessage	createCancelMeetingMessage()	Creates a local meeting acceptance message that can be customized and sent.
DeclineMeetingInvitationMessage	createDeclineMessage()	Creates a local meeting declination message that can be customized and sent.
ResponseMessage	createForward()	Creates a forward message from this appointment.
ResponseMessage	createReply(boolean replyAll)	Creates a reply response to the organizer and/or attendees of the meeting.
CalendarActionResults	decline(boolean sendResponse)	Declines the meeting invitation.
void	delete(DeleteMode deleteMode, SendCancellationsMode sendCancellationsMode)	Deletes this appointment.
void	forward(MessageBody bodyPrefix, Iterable<EmailAddress> toRecipients)	Forwards the appointment.
void	forward(MessageBody bodyPrefix, EmailAddress... toRecipients)	Forwards the appointment.
Integer	getAdjacentMeetingCount()	Gets the number of calendar entries that are adjacent to this appointment in the authenticated user's calendar.
ItemCollection<Appointment>	getAdjacentMeetings()	Gets a list of meetings that conflict with this appointment in the authenticated user's calendar.
Boolean	getAllowNewTimeProposal()	Gets a value indicating whether new time proposals are allowed for attendees of this meeting.
Date	getAppointmentReplyTime()	Gets the time when the attendee replied to the meeting request.
Integer	getAppointmentSequenceNumber()	Gets the sequence number of this appointment.
Integer	getAppointmentState()	Gets the state of this appointment.
AppointmentType	getAppointmentType()	Gets a value indicating the type of this appointment.
Integer	getConferenceType()	Gets the type of conferencing that will be used during the meeting.
Integer	getConflictingMeetingCount()	Gets the number of calendar entries that conflict with this appointment in the authenticated user's calendar.
ItemCollection<Appointment>	getConflictingMeetings()	Gets a list of meetings that conflict with this appointment in the authenticated user's calendar.
protected SendCancellationsMode	getDefaultSendCancellationsMode()	Gets the default setting for sending cancellations on Delete.
protected SendInvitationsMode	getDefaultSendInvitationsMode()	Gets the default settings for sending invitations on Save.
protected SendInvitationsOrCancellationsMode	getDefaultSendInvitationsOrCancellationsMode()	Gets the default settings for sending invitations on Save.
DeletedOccurrenceInfoCollection	getDeletedOccurrences()	Gets a list of deleted occurrences for this meeting.
TimeSpan	getDuration()	Gets the duration of this appointment.
Date	getEnd()	Gets or sets the end time of the appointment.
TimeZoneDefinition	getEndTimeZone()	Gets the start time zone.
OccurrenceInfo	getFirstOccurrence()	Gets an OccurrenceInfo identifying the first occurrence of this meeting.
Date	getICalDateTimeStamp()	Gets the ICalendar DateTimeStamp.
Date	getICalRecurrenceId()	Gets the ICalendar RecurrenceId.
String	getICalUid()	Gets the ICalendar Uid.
Boolean	getIsAllDayEvent()	Gets a value indicating whether this appointment is an all day event.
Boolean	getIsCancelled()	Gets a value indicating whether the appointment has been cancelled.
protected boolean	getIsCustomDateTimeScopingRequired()	Determines whether property defined with ScopedDateTimePropertyDefinition require custom time zone scoping.
Boolean	getIsMeeting()	Gets a value indicating whether the appointment is a meeting.
Boolean	getIsOnlineMeeting()	Gets a value indicating whether this is an online meeting.
Boolean	getIsOrganizer()	Gets a value indicating whether the appointment is recurring.
Boolean	getIsRecurring()	Gets a value indicating whether the appointment is recurring.
Boolean	getIsResponseRequested()	Gets a value indicating whether response are requested when invitations are sent for this meeting.
OccurrenceInfo	getLastOccurrence()	Gets an OccurrenceInfo identifying the first occurrence of this meeting.
LegacyFreeBusyStatus	getLegacyFreeBusyStatus()	Gets a value indicating the free/busy status of the owner of this appointment.
String	getLocation()	Gets the location of this appointment.
Boolean	getMeetingRequestWasSent()	Gets a value indicating whether the meeting request has already been sent.
String	getMeetingWorkspaceUrl()	Gets the URL of the meeting workspace.
ExchangeVersion	getMinimumRequiredServerVersion()	Gets the minimum required server version.
OccurrenceInfoCollection	getModifiedOccurrences()	Gets a list of modified occurrences for this meeting.
MeetingResponseType	getMyResponseType()	Gets a value indicating what was the last response of the user that loaded this meeting.
String	getNetShowUrl()	Gets the URL of the Microsoft NetShow online meeting.
AttendeeCollection	getOptionalAttendees()	Gets a list of optional attendeed for this meeting.
EmailAddress	getOrganizer()	Gets the organizer of this meeting.
Date	getOriginalStart()	Gets the original start time of this appointment.
Recurrence	getRecurrence()	Gets the recurrence pattern for this appointment.
AttendeeCollection	getRequiredAttendees()	Gets a list of required attendees for this meeting.
AttendeeCollection	getResources()	Gets a list of resources for this meeting.
ServiceObjectSchema	getSchema()	Internal method to return the schema associated with this type of object.
Date	getStart()	Gets the start time of the appointment.
TimeZoneDefinition	getStartTimeZone()	Gets the start time zone.
String	getTimeZone()	Gets the name of the time zone this appointment is defined in.
String	getWhen()	Gets a text indicating when this appointment occurs.
protected CalendarActionResults	internalAccept(boolean tentative, boolean sendResponse)	Accepts the meeting.
void	reply(MessageBody bodyPrefix, boolean replyAll)	Replies to the organizer and/or the attendees of the meeting.
void	save(WellKnownFolderName destinationFolderName, SendInvitationsMode sendInvitationsMode)	Saves this appointment in the specified folder.
void	save(SendInvitationsMode sendInvitationsMode)	Saves this appointment in the Calendar folder.
void	save(FolderId destinationFolderId, SendInvitationsMode sendInvitationsMode)	Saves this appointment in the specified folder.
void	setAllowNewTimeProposal(Boolean value)	Sets the allow new time proposal.
void	setConferenceType(Integer value)	Sets the conference type.
void	setEnd(Date value)	Sets the end.
void	setEndTimeZone(TimeZoneDefinition value)	Sets the start time zone.
void	setICalUid(String value)	Sets the ICalendar Uid.
void	setIsAllDayEvent(Boolean value)	Sets the checks if is all day event.
void	setIsOnlineMeeting(Boolean value)	Sets the checks if is online meeting.
void	setIsResponseRequested(Boolean value)	Sets the checks if is response requested.
void	setLegacyFreeBusyStatus(LegacyFreeBusyStatus value)	Sets the legacy free busy status.
void	setLocation(String value)	Sets the location.
void	setMeetingWorkspaceUrl(String value)	Sets the meeting workspace url.
void	setMyResponseType(MeetingResponseType value)	Gets a value indicating what was the last response of the user that loaded this meeting.
void	setNetShowUrl(String value)	Sets the net show url.
void	setRecurrence(Recurrence value)	Sets the recurrence.
void	setStart(Date value)	Sets the start.
void	setStartTimeZone(TimeZoneDefinition value)	Sets the start time zone.
void	update(ConflictResolutionMode conflictResolutionMode, SendInvitationsOrCancellationsMode sendInvitationsOrCancellationsMode)	Applies the local changes that have been made to this appointment.
void	validate()	Validates this instance.

Methods inherited from class microsoft.exchange.webservices.data.core.service.item.Item

copy, copy, delete, getAllowedResponseActions, getAttachments, getBody, getCategories, getConversationId, getCulture, getDateTimeCreated, getDateTimeReceived, getDateTimeSent, getDefaultAffectedTaskOccurrences, getDisplayCc, getDisplayTo, getEffectiveRights, getExtendedProperties, getHasAttachments, getId, getIdPropertyDefinition, getImportance, getInReplyTo, getInternetMessageHeaders, getIsAssociated, getIsDraft, getIsFromMe, getIsNew, getIsReminderSet, getIsResend, getIsSubmitted, getIsTimeZoneHeaderRequired, getIsUnmodified, getItemClass, getLastModifiedName, getLastModifiedTime, getMimeContent, getParentAttachment, getParentFolderId, getReminderDueBy, getReminderMinutesBeforeStart, getRootItemId, getSensitivity, getSize, getSubject, getUniqueBody, getWebClientEditFormQueryString, getWebClientReadFormQueryString, hasUnprocessedAttachmentChanges, internalCreate, internalDelete, internalLoad, internalUpdate, isAttachment, move, move, removeExtendedProperty, save, save, save, setBody, setCategories, setCulture, setExtendedProperty, setImportance, setInReplyTo, setIsReminderSet, setItemClass, setMimeContent, setReminderDueBy, setReminderMinutesBeforeStart, setSensitivity, setSubject, throwIfThisIsAttachment, update

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

addServiceObjectChangedEvent, changed, clearChangeLog, clearServiceObjectChangedEvent, getChangeXmlElementName, getDeleteFieldXmlElementName, getLoadedPropertyDefinitions, getObjectFromPropertyDefinition, getPropertyBag, getService, getSetFieldXmlElementName, 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

Appointment

public Appointment(ExchangeService service)
            throws Exception

Initializes an unsaved local instance of Appointment". To bind to an existing appointment, use Appointment.Bind() instead.

Parameters:

service - The ExchangeService instance to which this appointmtnt is bound.

Throws:

Exception - the exception

Appointment

public Appointment(ItemAttachment parentAttachment,
                   boolean isNew)
            throws Exception

Initializes a new instance of Appointment.

Parameters:

parentAttachment - the parent attachment

isNew - If true, attachment is new.

Throws:

Exception - the exception

Method Detail

bind

public static Appointment bind(ExchangeService service,
                               ItemId id,
                               PropertySet propertySet)
                        throws Exception

Binds to an existing appointment 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:

An Appointment instance representing the appointment corresponding to the specified Id.

Throws:

Exception - the exception

bind

public static Appointment bind(ExchangeService service,
                               ItemId id)
                        throws Exception

Binds to an existing appointment and loads its first class property. Calling this method results in a call to EWS.

Parameters:

service - the service

id - the id

Returns:

An Appointment instance representing the appointment corresponding to the specified Id.

Throws:

Exception - the exception

bindToOccurrence

public static Appointment bindToOccurrence(ExchangeService service,
                                           ItemId recurringMasterId,
                                           int occurenceIndex)
                                    throws Exception

Binds to an existing appointment and loads its first class property. Calling this method results in a call to EWS.

Parameters:

service - the service

recurringMasterId - the recurring master id

occurenceIndex - the occurence index

Returns:

An Appointment instance representing the appointment corresponding to the specified Id.

Throws:

Exception - the exception

bindToOccurrence

public static Appointment bindToOccurrence(ExchangeService service,
                                           ItemId recurringMasterId,
                                           int occurenceIndex,
                                           PropertySet propertySet)
                                    throws Exception

Binds to an existing appointment and loads its first class property. Calling this method results in a call to EWS.

Parameters:

service - the service

recurringMasterId - the recurring master id

occurenceIndex - the occurence index

propertySet - the property set

Returns:

An Appointment instance representing the appointment corresponding to the specified Id.

Throws:

Exception - the exception

bindToRecurringMaster

public static Appointment bindToRecurringMaster(ExchangeService service,
                                                ItemId occurrenceId)
                                         throws Exception

Binds to the master appointment of a recurring series and loads its first class property. Calling this method results in a call to EWS.

Parameters:

service - the service

occurrenceId - the occurrence id

Returns:

An Appointment instance representing the appointment corresponding to the specified Id.

Throws:

Exception - the exception

bindToRecurringMaster

public static Appointment bindToRecurringMaster(ExchangeService service,
                                                ItemId occurrenceId,
                                                PropertySet propertySet)
                                         throws Exception

Binds to the master appointment of a recurring series and loads its first class property. Calling this method results in a call to EWS.

Parameters:

service - the service

occurrenceId - the occurrence id

propertySet - the property set

Returns:

An Appointment instance representing the appointment corresponding to the specified Id.

Throws:

Exception - the exception

getSchema

public ServiceObjectSchema getSchema()

Internal method to return the schema associated with this type of object.

Overrides:

getSchema in class Item

Returns:

The schema associated with this type of object

getMinimumRequiredServerVersion

public ExchangeVersion getMinimumRequiredServerVersion()

Gets the minimum required server version.

Overrides:

getMinimumRequiredServerVersion in class Item

Returns:

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

getIsCustomDateTimeScopingRequired

protected boolean getIsCustomDateTimeScopingRequired()

Determines whether property defined with ScopedDateTimePropertyDefinition require custom time zone scoping.

Overrides:

getIsCustomDateTimeScopingRequired in class ServiceObject

Returns:

if this item type requires custom scoping for scoped date/time property; otherwise, .

validate

public void validate()
              throws Exception

Validates this instance.

Overrides:

validate in class Item

Throws:

Exception

createReply

public ResponseMessage createReply(boolean replyAll)
                            throws Exception

Creates a reply response to the organizer and/or attendees of the meeting.

Parameters:

replyAll - the reply all

Returns:

A ResponseMessage representing the reply response that can subsequently be modified and sent.

Throws:

Exception - the exception

reply

public void reply(MessageBody bodyPrefix,
                  boolean replyAll)
           throws Exception

Replies to the organizer and/or the attendees of the meeting. Calling this method results in a call to EWS.

Parameters:

bodyPrefix - the body prefix

replyAll - the reply all

Throws:

Exception - the exception

createForward

public ResponseMessage createForward()
                              throws Exception

Creates a forward message from this appointment.

Returns:

A ResponseMessage representing the forward response that can subsequently be modified and sent.

Throws:

Exception - the exception

forward

public void forward(MessageBody bodyPrefix,
                    EmailAddress... toRecipients)
             throws Exception

Forwards the appointment. Calling this method results in a call to EWS.

Parameters:

bodyPrefix - the body prefix

toRecipients - the to recipients

Throws:

Exception - the exception

forward

public void forward(MessageBody bodyPrefix,
                    Iterable<EmailAddress> toRecipients)
             throws Exception

Forwards the appointment. Calling this method results in a call to EWS.

Parameters:

bodyPrefix - the body prefix

toRecipients - the to recipients

Throws:

Exception - the exception

save

public void save(WellKnownFolderName destinationFolderName,
                 SendInvitationsMode sendInvitationsMode)
          throws Exception

Saves this appointment in the specified folder. Calling this method results in at least one call to EWS. Mutliple calls to EWS might be made if attachments have been added.

Parameters:

destinationFolderName - the destination folder name

sendInvitationsMode - the send invitations mode

Throws:

Exception - the exception

save

public void save(FolderId destinationFolderId,
                 SendInvitationsMode sendInvitationsMode)
          throws Exception

Saves this appointment in the specified folder. Calling this method results in at least one call to EWS. Mutliple calls to EWS might be made if attachments have been added.

Parameters:

destinationFolderId - the destination folder id

sendInvitationsMode - the send invitations mode

Throws:

Exception - the exception

save

public void save(SendInvitationsMode sendInvitationsMode)
          throws Exception

Saves this appointment in the Calendar folder. Calling this method results in at least one call to EWS. Mutliple calls to EWS might be made if attachments have been added.

Parameters:

sendInvitationsMode - the send invitations mode

Throws:

Exception - the exception

update

public void update(ConflictResolutionMode conflictResolutionMode,
                   SendInvitationsOrCancellationsMode sendInvitationsOrCancellationsMode)
            throws Exception

Applies the local changes that have been made to this appointment. Calling this method results in at least one call to EWS. Mutliple calls to EWS might be made if attachments have been added or removed.

Parameters:

conflictResolutionMode - the conflict resolution mode

sendInvitationsOrCancellationsMode - the send invitations or cancellations mode

Throws:

Exception - the exception

delete

public void delete(DeleteMode deleteMode,
                   SendCancellationsMode sendCancellationsMode)
            throws Exception

Deletes this appointment. Calling this method results in a call to EWS.

Parameters:

deleteMode - the delete mode

sendCancellationsMode - the send cancellations mode

Throws:

Exception - the exception

createAcceptMessage

public AcceptMeetingInvitationMessage createAcceptMessage(boolean tentative)
                                                   throws Exception

Creates a local meeting acceptance message that can be customized and sent.

Specified by:

createAcceptMessage in interface ICalendarActionProvider

Parameters:

tentative - the tentative

Returns:

An AcceptMeetingInvitationMessage representing the meeting acceptance message.

Throws:

Exception - the exception

createCancelMeetingMessage

public CancelMeetingMessage createCancelMeetingMessage()
                                                throws Exception

Creates a local meeting acceptance message that can be customized and sent.

Returns:

A CancelMeetingMessage representing the meeting cancellation message.

Throws:

Exception - the exception

createDeclineMessage

public DeclineMeetingInvitationMessage createDeclineMessage()
                                                     throws Exception

Creates a local meeting declination message that can be customized and sent.

Specified by:

createDeclineMessage in interface ICalendarActionProvider

Returns:

A DeclineMeetingInvitation representing the meeting declination message.

Throws:

Exception - the exception

accept

public CalendarActionResults accept(boolean sendResponse)
                             throws Exception

Accepts the meeting. Calling this method results in a call to EWS.

Specified by:

accept in interface ICalendarActionProvider

Parameters:

sendResponse - the send response

Returns:

A CalendarActionResults object containing the various item that were created or modified as a results of this operation.

Throws:

Exception - the exception

acceptTentatively

public CalendarActionResults acceptTentatively(boolean sendResponse)
                                        throws Exception

Tentatively accepts the meeting. Calling this method results in a call to EWS.

Specified by:

acceptTentatively in interface ICalendarActionProvider

Parameters:

sendResponse - the send response

Returns:

A CalendarActionResults object containing the various item that were created or modified as a results of this operation.

Throws:

Exception - the exception

internalAccept

protected CalendarActionResults internalAccept(boolean tentative,
                                               boolean sendResponse)
                                        throws Exception

Accepts the meeting.

Parameters:

tentative - the tentative

sendResponse - the send response

Returns:

A CalendarActionResults object containing the various item that were created or modified as a results of this operation.

Throws:

Exception - the exception

cancelMeeting

public CalendarActionResults cancelMeeting()
                                    throws Exception

Cancels the meeting and sends cancellation messages to all attendees. Calling this method results in a call to EWS.

Returns:

A CalendarActionResults object containing the various item that were created or modified as a results of this operation.

Throws:

Exception - the exception

cancelMeeting

public CalendarActionResults cancelMeeting(String cancellationMessageText)
                                    throws Exception

Cancels the meeting and sends cancellation messages to all attendees. Calling this method results in a call to EWS.

Parameters:

cancellationMessageText - the cancellation message text

Returns:

A CalendarActionResults object containing the various item that were created or modified as a results of this operation.

Throws:

Exception - the exception

decline

public CalendarActionResults decline(boolean sendResponse)
                              throws Exception

Declines the meeting invitation. Calling this method results in a call to EWS.

Specified by:

decline in interface ICalendarActionProvider

Parameters:

sendResponse - the send response

Returns:

A CalendarActionResults object containing the various item that were created or modified as a results of this operation.

Throws:

Exception - the exception

getDefaultSendCancellationsMode

protected SendCancellationsMode getDefaultSendCancellationsMode()

Gets the default setting for sending cancellations on Delete.

Overrides:

getDefaultSendCancellationsMode in class Item

Returns:

If Delete() is called on Appointment, we want to send cancellations and save a copy.

getDefaultSendInvitationsMode

protected SendInvitationsMode getDefaultSendInvitationsMode()

Gets the default settings for sending invitations on Save.

Overrides:

getDefaultSendInvitationsMode in class Item

Returns:

the default send invitations mode

getDefaultSendInvitationsOrCancellationsMode

protected SendInvitationsOrCancellationsMode getDefaultSendInvitationsOrCancellationsMode()

Gets the default settings for sending invitations on Save.

Overrides:

getDefaultSendInvitationsOrCancellationsMode in class Item

Returns:

the default send invitations or cancellations mode

getStart

public Date getStart()
              throws ServiceLocalException

Gets the start time of the appointment.

Returns:

the start

Throws:

ServiceLocalException - the service local exception

setStart

public void setStart(Date value)
              throws Exception

Sets the start.

Parameters:

value - the new start

Throws:

Exception - the exception

getEnd

public Date getEnd()
            throws ServiceLocalException

Gets or sets the end time of the appointment.

Returns:

the end

Throws:

ServiceLocalException - the service local exception

setEnd

public void setEnd(Date value)
            throws Exception

Sets the end.

Parameters:

value - the new end

Throws:

Exception - the exception

getOriginalStart

public Date getOriginalStart()
                      throws ServiceLocalException

Gets the original start time of this appointment.

Returns:

the original start

Throws:

ServiceLocalException - the service local exception

getIsAllDayEvent

public Boolean getIsAllDayEvent()
                         throws ServiceLocalException

Gets a value indicating whether this appointment is an all day event.

Returns:

the checks if is all day event

Throws:

ServiceLocalException - the service local exception

setIsAllDayEvent

public void setIsAllDayEvent(Boolean value)
                      throws Exception

Sets the checks if is all day event.

Parameters:

value - the new checks if is all day event

Throws:

Exception - the exception

getLegacyFreeBusyStatus

public LegacyFreeBusyStatus getLegacyFreeBusyStatus()
                                             throws ServiceLocalException

Gets a value indicating the free/busy status of the owner of this appointment.

Returns:

the legacy free busy status

Throws:

ServiceLocalException - the service local exception

setLegacyFreeBusyStatus

public void setLegacyFreeBusyStatus(LegacyFreeBusyStatus value)
                             throws Exception

Sets the legacy free busy status.

Parameters:

value - the new legacy free busy status

Throws:

Exception - the exception

getLocation

public String getLocation()
                   throws ServiceLocalException

Gets the location of this appointment.

Returns:

the location

Throws:

ServiceLocalException - the service local exception

setLocation

public void setLocation(String value)
                 throws Exception

Sets the location.

Parameters:

value - the new location

Throws:

Exception - the exception

getWhen

public String getWhen()
               throws ServiceLocalException

Gets a text indicating when this appointment occurs. The text returned by When is localized using the Exchange Server culture or using the culture specified in the PreferredCulture property of the ExchangeService object this appointment is bound to.

Returns:

the when

Throws:

ServiceLocalException - the service local exception

getIsMeeting

public Boolean getIsMeeting()
                     throws ServiceLocalException

Gets a value indicating whether the appointment is a meeting.

Returns:

the checks if is meeting

Throws:

ServiceLocalException - the service local exception

getIsCancelled

public Boolean getIsCancelled()
                       throws ServiceLocalException

Gets a value indicating whether the appointment has been cancelled.

Returns:

the checks if is cancelled

Throws:

ServiceLocalException - the service local exception

getIsRecurring

public Boolean getIsRecurring()
                       throws ServiceLocalException

Gets a value indicating whether the appointment is recurring.

Returns:

the checks if is recurring

Throws:

ServiceLocalException - the service local exception

getIsOrganizer

public Boolean getIsOrganizer()
                       throws ServiceLocalException

Gets a value indicating whether the appointment is recurring.

Returns:

the checks if is recurring

Throws:

ServiceLocalException - the service local exception

getMeetingRequestWasSent

public Boolean getMeetingRequestWasSent()
                                 throws ServiceLocalException

Gets a value indicating whether the meeting request has already been sent.

Returns:

the meeting request was sent

Throws:

ServiceLocalException - the service local exception

getIsResponseRequested

public Boolean getIsResponseRequested()
                               throws ServiceLocalException

Gets a value indicating whether response are requested when invitations are sent for this meeting.

Returns:

the checks if is response requested

Throws:

ServiceLocalException - the service local exception

setIsResponseRequested

public void setIsResponseRequested(Boolean value)
                            throws Exception

Sets the checks if is response requested.

Parameters:

value - the new checks if is response requested

Throws:

Exception - the exception

getAppointmentType

public AppointmentType getAppointmentType()
                                   throws ServiceLocalException

Gets a value indicating the type of this appointment.

Returns:

the appointment type

Throws:

ServiceLocalException - the service local exception

setMyResponseType

public void setMyResponseType(MeetingResponseType value)
                       throws Exception

Gets a value indicating what was the last response of the user that loaded this meeting.

Parameters:

value - the my response type

Throws:

Exception

getMyResponseType

public MeetingResponseType getMyResponseType()
                                      throws ServiceLocalException

Gets a value indicating what was the last response of the user that loaded this meeting.

Returns:

the my response type

Throws:

ServiceLocalException - the service local exception

getOrganizer

public EmailAddress getOrganizer()
                          throws ServiceLocalException

Gets the organizer of this meeting. The Organizer property is read-only and is only relevant for attendees. The organizer of a meeting is automatically set to the user that created the meeting.

Returns:

the organizer

Throws:

ServiceLocalException - the service local exception

getRequiredAttendees

public AttendeeCollection getRequiredAttendees()
                                        throws ServiceLocalException

Gets a list of required attendees for this meeting.

Returns:

the required attendees

Throws:

ServiceLocalException - the service local exception

getOptionalAttendees

public AttendeeCollection getOptionalAttendees()
                                        throws ServiceLocalException

Gets a list of optional attendeed for this meeting.

Returns:

the optional attendees

Throws:

ServiceLocalException - the service local exception

getResources

public AttendeeCollection getResources()
                                throws ServiceLocalException

Gets a list of resources for this meeting.

Returns:

the resources

Throws:

ServiceLocalException - the service local exception

getConflictingMeetingCount

public Integer getConflictingMeetingCount()
                                   throws ServiceLocalException

Gets the number of calendar entries that conflict with this appointment in the authenticated user's calendar.

Returns:

the conflicting meeting count

Throws:

ServiceLocalException - the service local exception

getAdjacentMeetingCount

public Integer getAdjacentMeetingCount()
                                throws ServiceLocalException

Gets the number of calendar entries that are adjacent to this appointment in the authenticated user's calendar.

Returns:

the adjacent meeting count

Throws:

ServiceLocalException - the service local exception

getConflictingMeetings

public ItemCollection<Appointment> getConflictingMeetings()
                                                   throws ServiceLocalException

Gets a list of meetings that conflict with this appointment in the authenticated user's calendar.

Returns:

the conflicting meetings

Throws:

ServiceLocalException - the service local exception

getAdjacentMeetings

public ItemCollection<Appointment> getAdjacentMeetings()
                                                throws ServiceLocalException

Gets a list of meetings that conflict with this appointment in the authenticated user's calendar.

Returns:

the adjacent meetings

Throws:

ServiceLocalException - the service local exception

getDuration

public TimeSpan getDuration()
                     throws ServiceLocalException

Gets the duration of this appointment.

Returns:

the duration

Throws:

ServiceLocalException - the service local exception

getTimeZone

public String getTimeZone()
                   throws ServiceLocalException

Gets the name of the time zone this appointment is defined in.

Returns:

the time zone

Throws:

ServiceLocalException - the service local exception

getAppointmentReplyTime

public Date getAppointmentReplyTime()
                             throws ServiceLocalException

Gets the time when the attendee replied to the meeting request.

Returns:

the appointment reply time

Throws:

ServiceLocalException - the service local exception

getAppointmentSequenceNumber

public Integer getAppointmentSequenceNumber()
                                     throws ServiceLocalException

Gets the sequence number of this appointment.

Returns:

the appointment sequence number

Throws:

ServiceLocalException - the service local exception

getAppointmentState

public Integer getAppointmentState()
                            throws ServiceLocalException

Gets the state of this appointment.

Returns:

the appointment state

Throws:

ServiceLocalException - the service local exception

getRecurrence

public Recurrence getRecurrence()
                         throws ServiceLocalException

Gets the recurrence pattern for this appointment. Available recurrence pattern classes include Recurrence.DailyPattern, Recurrence.MonthlyPattern and Recurrence.YearlyPattern.

Returns:

the recurrence

Throws:

ServiceLocalException - the service local exception

setRecurrence

public void setRecurrence(Recurrence value)
                   throws Exception

Sets the recurrence.

Parameters:

value - the new recurrence

Throws:

Exception - the exception

getFirstOccurrence

public OccurrenceInfo getFirstOccurrence()
                                  throws ServiceLocalException

Gets an OccurrenceInfo identifying the first occurrence of this meeting.

Returns:

the first occurrence

Throws:

ServiceLocalException - the service local exception

getLastOccurrence

public OccurrenceInfo getLastOccurrence()
                                 throws ServiceLocalException

Gets an OccurrenceInfo identifying the first occurrence of this meeting.

Returns:

the last occurrence

Throws:

ServiceLocalException - the service local exception

getModifiedOccurrences

public OccurrenceInfoCollection getModifiedOccurrences()
                                                throws ServiceLocalException

Gets a list of modified occurrences for this meeting.

Returns:

the modified occurrences

Throws:

ServiceLocalException - the service local exception

getDeletedOccurrences

public DeletedOccurrenceInfoCollection getDeletedOccurrences()
                                                      throws ServiceLocalException

Gets a list of deleted occurrences for this meeting.

Returns:

the deleted occurrences

Throws:

ServiceLocalException - the service local exception

getStartTimeZone

public TimeZoneDefinition getStartTimeZone()
                                    throws ServiceLocalException

Gets the start time zone.

Returns:

the start time zone

Throws:

ServiceLocalException - the service local exception

setStartTimeZone

public void setStartTimeZone(TimeZoneDefinition value)
                      throws Exception

Sets the start time zone.

Parameters:

value - the new start time zone

Throws:

Exception - the exception

getEndTimeZone

public TimeZoneDefinition getEndTimeZone()
                                  throws ServiceLocalException

Gets the start time zone.

Returns:

the start time zone

Throws:

ServiceLocalException - the service local exception

setEndTimeZone

public void setEndTimeZone(TimeZoneDefinition value)
                    throws Exception

Sets the start time zone.

Parameters:

value - the new end time zone

Throws:

Exception - the exception

getConferenceType

public Integer getConferenceType()
                          throws ServiceLocalException

Gets the type of conferencing that will be used during the meeting.

Returns:

the conference type

Throws:

ServiceLocalException - the service local exception

setConferenceType

public void setConferenceType(Integer value)
                       throws Exception

Sets the conference type.

Parameters:

value - the new conference type

Throws:

Exception - the exception

getAllowNewTimeProposal

public Boolean getAllowNewTimeProposal()
                                throws ServiceLocalException

Gets a value indicating whether new time proposals are allowed for attendees of this meeting.

Returns:

the allow new time proposal

Throws:

ServiceLocalException - the service local exception

setAllowNewTimeProposal

public void setAllowNewTimeProposal(Boolean value)
                             throws Exception

Sets the allow new time proposal.

Parameters:

value - the new allow new time proposal

Throws:

Exception - the exception

getIsOnlineMeeting

public Boolean getIsOnlineMeeting()
                           throws ServiceLocalException

Gets a value indicating whether this is an online meeting.

Returns:

the checks if is online meeting

Throws:

ServiceLocalException - the service local exception

setIsOnlineMeeting

public void setIsOnlineMeeting(Boolean value)
                        throws Exception

Sets the checks if is online meeting.

Parameters:

value - the new checks if is online meeting

Throws:

Exception - the exception

getMeetingWorkspaceUrl

public String getMeetingWorkspaceUrl()
                              throws ServiceLocalException

Gets the URL of the meeting workspace. A meeting workspace is a shared Web site for planning meetings and tracking results.

Returns:

the meeting workspace url

Throws:

ServiceLocalException - the service local exception

setMeetingWorkspaceUrl

public void setMeetingWorkspaceUrl(String value)
                            throws Exception

Sets the meeting workspace url.

Parameters:

value - the new meeting workspace url

Throws:

Exception - the exception

getNetShowUrl

public String getNetShowUrl()
                     throws ServiceLocalException

Gets the URL of the Microsoft NetShow online meeting.

Returns:

the net show url

Throws:

ServiceLocalException - the service local exception

setNetShowUrl

public void setNetShowUrl(String value)
                   throws Exception

Sets the net show url.

Parameters:

value - the new net show url

Throws:

Exception - the exception

getICalUid

public String getICalUid()
                  throws ServiceLocalException

Gets the ICalendar Uid.

Returns:

the i cal uid

Throws:

ServiceLocalException - the service local exception

setICalUid

public void setICalUid(String value)
                throws Exception

Sets the ICalendar Uid.

Parameters:

value - the i cal uid

Throws:

Exception

getICalRecurrenceId

public Date getICalRecurrenceId()
                         throws ServiceLocalException

Gets the ICalendar RecurrenceId.

Returns:

the i cal recurrence id

Throws:

ServiceLocalException - the service local exception

getICalDateTimeStamp

public Date getICalDateTimeStamp()
                          throws ServiceLocalException

Gets the ICalendar DateTimeStamp.

Returns:

the i cal date time stamp

Throws:

ServiceLocalException - the service local exception