com.moyosoft.exchange.calendar
Interface ExchangeCalendarItem

All Superinterfaces:

ExchangeItem, ExchangeMeeting

public interface ExchangeCalendarItem
extends ExchangeItem, ExchangeMeeting

Represents an Exchange calendar item like an appointment or a meeting.

A new appointment can be created with the methods Exchange.createCalendarItem() or ExchangeFolder.createCalendarItem(). To save the new appointment to the calendar, call the method save().

This class provides getter and setter methods to access or modify the appointment's properties.

Example code that displays appointments for a specific date span:

Exchange exchange = new Exchange("hostname", "username", "password");
ExchangeFolder calendar = exchange.getCalendarFolder();

Date now = new Date();
Date oneDayAgo = new Date(now.getTime() - 86400000);

Iterable<ExchangeItem> items = calendar.getItems().iterableForCalendar(oneDayAgo, now);
for(ExchangeItem item : items)
{
ExchangeCalendarItem appointment = (ExchangeCalendarItem) item;
System.out.println(appointment.getSubject());
}


See Also:

Exchange.createCalendarItem(), ExchangeFolder.createCalendarItem(), ExchangeItem.save()

Method Summary

void	addOptionalAttendee(java.lang.String optionalAttendeeEmailAddress) Adds a new optional attendee to the current optional attendees list.
void	addRequiredAttendee(java.lang.String requiredAttendeeEmailAddress) Adds a new required attendee to the current required attendees list.
void	addResource(java.lang.String resourceEmailAddress) Adds a new resource to the current resources list.
void	clearOptionalAttendees()
void	clearRecurrencePattern() Clears the recurrence pattern of this item making it non-recurring.
void	clearRequiredAttendees()
void	clearResources()
void	delete(boolean moveToDeletedItems) Deletes this item.
void	delete(boolean moveToDeletedItems, boolean doNotSaveSentMeetingRequestCopy) Deletes this item.
void	deleteOnly(boolean moveToDeletedItems) Deletes this item.
int	getAdjacentMeetingCount() Returns the total number of calendar items that are adjacent to this meeting's time.
java.util.List<ExchangeItem>	getAdjacentMeetings() Returns all calendar items that are adjacent to this meeting's time.
boolean	getAllowNewTimeProposal() Returns true if a new meeting time can be proposed for this meeting by an attendee, false otherwise.
java.util.Date	getAppointmentReplyTime() Returns the date and time when an attendee replied to a meeting request.
int	getAppointmentSequenceNumber() Returns the sequence number of a version of an appointment.
CalendarItemType	getCalendarItemType() Returns the occurrence type of this calendar item.
int	getConferenceType() Returns the type of conferencing that is performed.
int	getConflictingMeetingCount() Returns the number of meetings that conflict with this calendar item.
java.util.List<ExchangeItem>	getConflictingMeetings() Returns all items that conflict with this meeting's time.
java.util.Date	getDateTimeStamp() Indicates the date and time that an instance of a iCalendar object was created.
java.lang.String	getDuration() Returns the duration of this calendar item.
java.util.Date	getEnd() Returns the end date and time of this calendar item.
FreeBusyStatus	getFreeBusyStatus() Returns the free/busy status of this calendar item.
java.lang.String	getLocation() Returns the location of this meeting or appointment.
boolean	getMeetingRequestWasSent() Returns true if a meeting request has been sent to requested attendees, false otherwise.
java.lang.String	getMeetingWorkspaceUrl() Returns the URL for the meeting workspace.
ResponseType	getMyResponseType() Returns the status of the response for this calendar item.
java.lang.String	getNetShowUrl() Returns the URL for a Microsoft NetShow online meeting.
java.util.List<ExchangeAttendee>	getOptionalAttendees() Returns a list of the optional attendees for this meeting.
java.lang.String	getOrganizerEmailAddress() Returns the e-mail address of the organizer of this meeting.
ExchangeMailbox	getOrganizerMailbox() Returns the mailbox of the organizer of this meeting.
java.lang.String	getOrganizerName() Returns the name of the organizer of this meeting.
java.util.Date	getOriginalStart() Returns the original start date and time of this calendar item.
java.util.Date	getRecurrenceId() The recurrence ID is used to identify a specific instance of a recurring calendar item.
ExchangeCalendarItem	getRecurrenceMaster() Returns the master of this occurrence of a recurring appointment.
ExchangeCalendarItem	getRecurrenceOccurrence(int occurrenceIndex) Returns the occurrence at the specified index of a recurring appointment.
RecurrencePattern	getRecurrencePattern() Returns the recurrence pattern of this item.
java.util.List<ExchangeAttendee>	getRequiredAttendees() Returns a list of the required attendees for this meeting.
java.util.List<ExchangeAttendee>	getResources() Returns a list of the resources for this meeting.
java.util.Date	getStart() Returns the start date and time of this calendar item.
java.lang.String	getTimeZone() Returns a textual description of a time zone.
java.lang.String	getUid() Returns an UID uniquely identifying a calendar item.
java.lang.String	getWhen() Returns textual information about when this appointment or meeting occurs.
boolean	isAllDayEvent() Returns true if this item is an all-day event; false otherwise.
boolean	isCancelled() Returns true if this meeting or appointment has been canceled, false otherwise.
boolean	isMeeting() Returns true if this calendar item is a meeting, false if it's an appointment.
boolean	isOnlineMeeting() Returns true if this meeting is online, false otherwise.
boolean	isRecurring() Returns true if this calendar item is part of a recurring item, false otherwise.
boolean	isResponseRequested() Indicates whether a response is required.
void	save() Saves all the changes made to this item in the Exchange store.
void	save(boolean overwriteIfConflict) Saves all the changes made to this item in the Exchange store.
void	save(boolean overwriteIfConflict, boolean notifyOnlyChangedAttendees) Saves all the changes made to this item in the Exchange store.
void	save(boolean overwriteIfConflict, boolean notifyOnlyChangedAttendees, boolean doNotSaveSentMeetingRequestCopy) Saves all the changes made to this item in the Exchange store.
void	saveOnly() Saves changes made to this item in the Exchange store without sending meeting invitations, cancellations or updates to attendees.
void	saveOnly(boolean overwriteIfConflict) Saves changes made to this item in the Exchange store without sending meeting invitations, cancellations or updates to attendees.
void	setAllowNewTimeProposal(boolean allowNewTimeProposal) Sets whether a new meeting time can be proposed for this meeting by an attendee.
void	setConferenceType(int conferenceType) Sets the type of conferencing that is performed.
void	setDateTimeStamp(java.util.Date dateTimeStamp)
void	setEnd(java.util.Date end) Sets the end date and time of this calendar item.
void	setFreeBusyStatus(FreeBusyStatus freeBusyStatus) Sets the free/busy status of this calendar item.
void	setIsAllDayEvent(boolean isAllDayEvent) Sets whether this item is an all-day event or not.
void	setIsCancelled(boolean isCancelled) Sets whether this calendar item is canceled or not.
void	setIsOnlineMeeting(boolean isOnlineMeeting) Sets whether this meeting is online.
void	setIsResponseRequested(boolean isResponseRequested) Sets whether a response is required.
void	setLocation(java.lang.String location) Sets the location of this calendar item.
void	setMeetingTimeZoneName(java.lang.String name) Deprecated. Use the method setStartTimeZone instead.
void	setMeetingWorkspaceUrl(java.lang.String meetingWorkspaceUrl) Sets the URL for the meeting workspace.
void	setMyResponseType(ResponseType myResponseType) Sets the status of the response for this calendar item.
void	setNetShowUrl(java.lang.String netShowUrl) Sets the URL for a Microsoft NetShow online meeting.
void	setOptionalAttendee(java.lang.String optionalAttendeeEmailAddress) Sets a single optional attendee for this meeting.
void	setOptionalAttendees(java.util.List<java.lang.String> optionalAttendeesEmailAddresses) Sets the list of optional attendees for this meeting.
void	setRecurrenceId(java.util.Date recurrenceId) The recurrence ID is used to identify a specific instance of a recurring calendar item.
void	setRequiredAttendee(java.lang.String requiredAttendeeEmailAddress) Sets a single required attendee for this meeting.
void	setRequiredAttendees(java.util.List<java.lang.String> requiredAttendeesEmailAddresses) Sets the list of required attendees for this meeting.
void	setResource(java.lang.String resourceEmailAddress) Sets a single resource scheduled for this meeting.
void	setResources(java.util.List<java.lang.String> resourcesEmailAddresses) Sets the list of resources for this meeting.
void	setStart(java.util.Date start) Sets the start date and time of this calendar item.
void	setStartTimeZone(java.util.TimeZone timeZone)
void	setWhen(java.lang.String when) Sets information about when this calendar item occurs.

Methods inherited from interface com.moyosoft.exchange.item.ExchangeItem

copyTo, copyTo, getAttachments, getBody, getBodyAsText, getBodyType, getCategories, getCulture, getDateTimeCreated, getDateTimeReceived, getDateTimeSent, getDisplayCc, getDisplayTo, getExtendedProperties, getImportance, getInReplyTo, getInternetMessageHeaders, getItemClass, getItemId, getItemIdChangeKey, getItemType, getLastModifiedName, getLastModifiedTime, getMimeContent, getMimeContentBytes, getMimeContentCharacterSet, getMimeContentReader, getMimeContentStream, getParentFolder, getParentFolderId, getParentFolderIdChangeKey, getReminderDueBy, getReminderMinutesBeforeStart, getResponsesTypes, getSensitivity, getSize, getSubject, hasVisibleAttachments, isDraft, isFromMe, isReminderSet, isResend, isStored, isSubmitted, moveTo, moveTo, saveTo, setBody, setBody, setCategories, setCulture, setImportance, setMimeContent, setMimeContent, setMimeContent, setReminder, setSensitivity, setSubject

Methods inherited from interface com.moyosoft.exchange.calendar.ExchangeMeeting

respond

Method Detail

getUid

java.lang.String getUid()
                        throws ExchangeServiceException

Returns an UID uniquely identifying a calendar item.

Specified by:

getUid in interface ExchangeMeeting

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

getRecurrenceId

java.util.Date getRecurrenceId()
                               throws ExchangeServiceException

The recurrence ID is used to identify a specific instance of a recurring calendar item.

Specified by:

getRecurrenceId in interface ExchangeMeeting

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

setRecurrenceId

void setRecurrenceId(java.util.Date recurrenceId)
                     throws ExchangeServiceException

The recurrence ID is used to identify a specific instance of a recurring calendar item.

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

getDateTimeStamp

java.util.Date getDateTimeStamp()
                                throws ExchangeServiceException

Indicates the date and time that an instance of a iCalendar object was created.

Specified by:

getDateTimeStamp in interface ExchangeMeeting

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

setDateTimeStamp

void setDateTimeStamp(java.util.Date dateTimeStamp)
                      throws ExchangeServiceException

Throws:

ExchangeServiceException

getStart

java.util.Date getStart()
                        throws ExchangeServiceException

Returns the start date and time of this calendar item. Applies only to a single occurrence of a calendar item.

Specified by:

getStart in interface ExchangeMeeting

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

setMeetingTimeZoneName

void setMeetingTimeZoneName(java.lang.String name)
                            throws ExchangeServiceException

Deprecated. Use the method setStartTimeZone instead.

Sets the TimeZone name for this calendar item. Only supported by Exchange 2007.

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

setStartTimeZone

void setStartTimeZone(java.util.TimeZone timeZone)
                      throws ExchangeServiceException

Throws:

ExchangeServiceException

setStart

void setStart(java.util.Date start)
              throws ExchangeServiceException

Sets the start date and time of this calendar item. Applies only to a single occurrence of a calendar item.

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

getEnd

java.util.Date getEnd()
                      throws ExchangeServiceException

Returns the end date and time of this calendar item. Applies only to a single occurrence of a calendar item.

Specified by:

getEnd in interface ExchangeMeeting

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

setEnd

void setEnd(java.util.Date end)
            throws ExchangeServiceException

Sets the end date and time of this calendar item. Applies only to a single occurrence of a calendar item.

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

getOriginalStart

java.util.Date getOriginalStart()
                                throws ExchangeServiceException

Returns the original start date and time of this calendar item.

Specified by:

getOriginalStart in interface ExchangeMeeting

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

isAllDayEvent

boolean isAllDayEvent()
                      throws ExchangeServiceException

Returns true if this item is an all-day event; false otherwise.

Specified by:

isAllDayEvent in interface ExchangeMeeting

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

setIsAllDayEvent

void setIsAllDayEvent(boolean isAllDayEvent)
                      throws ExchangeServiceException

Sets whether this item is an all-day event or not.

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

getFreeBusyStatus

FreeBusyStatus getFreeBusyStatus()
                                 throws ExchangeServiceException

Returns the free/busy status of this calendar item.

Specified by:

getFreeBusyStatus in interface ExchangeMeeting

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

setFreeBusyStatus

void setFreeBusyStatus(FreeBusyStatus freeBusyStatus)
                       throws ExchangeServiceException

Sets the free/busy status of this calendar item.

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

getLocation

java.lang.String getLocation()
                             throws ExchangeServiceException

Returns the location of this meeting or appointment.

Specified by:

getLocation in interface ExchangeMeeting

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

setLocation

void setLocation(java.lang.String location)
                 throws ExchangeServiceException

Sets the location of this calendar item.

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

getWhen

java.lang.String getWhen()
                         throws ExchangeServiceException

Returns textual information about when this appointment or meeting occurs.

Specified by:

getWhen in interface ExchangeMeeting

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

setWhen

void setWhen(java.lang.String when)
             throws ExchangeServiceException

Sets information about when this calendar item occurs.

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

isMeeting

boolean isMeeting()
                  throws ExchangeServiceException

Returns true if this calendar item is a meeting, false if it's an appointment.

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

isCancelled

boolean isCancelled()
                    throws ExchangeServiceException

Returns true if this meeting or appointment has been canceled, false otherwise.

Specified by:

isCancelled in interface ExchangeMeeting

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

setIsCancelled

void setIsCancelled(boolean isCancelled)
                    throws ExchangeServiceException

Sets whether this calendar item is canceled or not.

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

isRecurring

boolean isRecurring()
                    throws ExchangeServiceException

Returns true if this calendar item is part of a recurring item, false otherwise.

Specified by:

isRecurring in interface ExchangeMeeting

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

getMeetingRequestWasSent

boolean getMeetingRequestWasSent()
                                 throws ExchangeServiceException

Returns true if a meeting request has been sent to requested attendees, false otherwise.

Specified by:

getMeetingRequestWasSent in interface ExchangeMeeting

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

isResponseRequested

boolean isResponseRequested()
                            throws ExchangeServiceException

Indicates whether a response is required.

Specified by:

isResponseRequested in interface ExchangeMeeting

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

setIsResponseRequested

void setIsResponseRequested(boolean isResponseRequested)
                            throws ExchangeServiceException

Sets whether a response is required.

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

getCalendarItemType

CalendarItemType getCalendarItemType()
                                     throws ExchangeServiceException

Returns the occurrence type of this calendar item. Possible returned values are:

CalendarItemType.Single: This item is not associated with a recurring calendar item.
CalendarItemType.Occurrence: This item is an occurrence of a recurring calendar item.
CalendarItemType.Exception: This item is an exception to a recurring calendar item.
CalendarItemType.RecurringMaster: This item is master for a set of recurring calendar items.

Specified by:

getCalendarItemType in interface ExchangeMeeting

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

getMyResponseType

ResponseType getMyResponseType()
                               throws ExchangeServiceException

Returns the status of the response for this calendar item.

Specified by:

getMyResponseType in interface ExchangeMeeting

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

setMyResponseType

void setMyResponseType(ResponseType myResponseType)
                       throws ExchangeServiceException

Sets the status of the response for this calendar item.

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

getOrganizerName

java.lang.String getOrganizerName()
                                  throws ExchangeServiceException

Returns the name of the organizer of this meeting.

Specified by:

getOrganizerName in interface ExchangeMeeting

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

getOrganizerEmailAddress

java.lang.String getOrganizerEmailAddress()
                                          throws ExchangeServiceException

Returns the e-mail address of the organizer of this meeting.

Specified by:

getOrganizerEmailAddress in interface ExchangeMeeting

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

getOrganizerMailbox

ExchangeMailbox getOrganizerMailbox()
                                    throws ExchangeServiceException

Returns the mailbox of the organizer of this meeting.

Specified by:

getOrganizerMailbox in interface ExchangeMeeting

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

getRequiredAttendees

java.util.List<ExchangeAttendee> getRequiredAttendees()
                                                      throws ExchangeServiceException

Returns a list of the required attendees for this meeting. The returned list may be null or empty if there are no required attendees.

Specified by:

getRequiredAttendees in interface ExchangeMeeting

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

setRequiredAttendees

void setRequiredAttendees(java.util.List<java.lang.String> requiredAttendeesEmailAddresses)
                          throws ExchangeServiceException

Sets the list of required attendees for this meeting. The list can be null or empty to specify that there's no required attendees.

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

setRequiredAttendee

void setRequiredAttendee(java.lang.String requiredAttendeeEmailAddress)
                         throws ExchangeServiceException

Sets a single required attendee for this meeting. The specified String is the attendee's e-mail address and can be null or empty to specify that there's no required attendees.

To set multiple required attendees use the method setRequiredAttendees(List). To add an attendee to the current required list, use the method addRequiredAttendee(String).

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

addRequiredAttendee

void addRequiredAttendee(java.lang.String requiredAttendeeEmailAddress)
                         throws ExchangeServiceException

Adds a new required attendee to the current required attendees list. The specified String is the new attendee's e-mail address.

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

getOptionalAttendees

java.util.List<ExchangeAttendee> getOptionalAttendees()
                                                      throws ExchangeServiceException

Returns a list of the optional attendees for this meeting. The returned list may be null or empty if there are no optional attendees.

Specified by:

getOptionalAttendees in interface ExchangeMeeting

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

setOptionalAttendees

void setOptionalAttendees(java.util.List<java.lang.String> optionalAttendeesEmailAddresses)
                          throws ExchangeServiceException

Sets the list of optional attendees for this meeting. The list can be null or empty to specify that there's no optional attendees.

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

setOptionalAttendee

void setOptionalAttendee(java.lang.String optionalAttendeeEmailAddress)
                         throws ExchangeServiceException

Sets a single optional attendee for this meeting. The specified String is the attendee's e-mail address and can be null or empty to specify that there's no optional attendees.

To set multiple optional attendees use the method setOptionalAttendees(List). To add an attendee to the current optional list, use the method addOptionalAttendee(String).

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

addOptionalAttendee

void addOptionalAttendee(java.lang.String optionalAttendeeEmailAddress)
                         throws ExchangeServiceException

Adds a new optional attendee to the current optional attendees list. The specified String is the new attendee's e-mail address.

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

getResources

java.util.List<ExchangeAttendee> getResources()
                                              throws ExchangeServiceException

Returns a list of the resources for this meeting. The returned list may be null or empty if there are no resources scheduled.

Specified by:

getResources in interface ExchangeMeeting

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

setResources

void setResources(java.util.List<java.lang.String> resourcesEmailAddresses)
                  throws ExchangeServiceException

Sets the list of resources for this meeting. The list can be null or empty to specify that there's no resources needed.

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

setResource

void setResource(java.lang.String resourceEmailAddress)
                 throws ExchangeServiceException

Sets a single resource scheduled for this meeting. The specified String is the resource's e-mail address and can be null or empty to specify that there's no resources needed.

To set multiple resources use the method setResources(List). To add a resource to the current list, use the method addResource(String).

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

addResource

void addResource(java.lang.String resourceEmailAddress)
                 throws ExchangeServiceException

Adds a new resource to the current resources list. The specified String is the new resource's e-mail address.

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

clearResources

void clearResources()
                    throws ExchangeServiceException

Throws:

ExchangeServiceException

clearRequiredAttendees

void clearRequiredAttendees()
                            throws ExchangeServiceException

Throws:

ExchangeServiceException

clearOptionalAttendees

void clearOptionalAttendees()
                            throws ExchangeServiceException

Throws:

ExchangeServiceException

getConflictingMeetingCount

int getConflictingMeetingCount()
                               throws ExchangeServiceException

Returns the number of meetings that conflict with this calendar item.

Specified by:

getConflictingMeetingCount in interface ExchangeMeeting

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

getAdjacentMeetingCount

int getAdjacentMeetingCount()
                            throws ExchangeServiceException

Returns the total number of calendar items that are adjacent to this meeting's time.

Specified by:

getAdjacentMeetingCount in interface ExchangeMeeting

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

getConflictingMeetings

java.util.List<ExchangeItem> getConflictingMeetings()
                                                    throws ExchangeServiceException

Returns all items that conflict with this meeting's time.

Specified by:

getConflictingMeetings in interface ExchangeMeeting

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

getAdjacentMeetings

java.util.List<ExchangeItem> getAdjacentMeetings()
                                                 throws ExchangeServiceException

Returns all calendar items that are adjacent to this meeting's time.

Specified by:

getAdjacentMeetings in interface ExchangeMeeting

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

getDuration

java.lang.String getDuration()
                             throws ExchangeServiceException

Returns the duration of this calendar item.

Specified by:

getDuration in interface ExchangeMeeting

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

getTimeZone

java.lang.String getTimeZone()
                             throws ExchangeServiceException

Returns a textual description of a time zone.

Specified by:

getTimeZone in interface ExchangeMeeting

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

getAppointmentReplyTime

java.util.Date getAppointmentReplyTime()
                                       throws ExchangeServiceException

Returns the date and time when an attendee replied to a meeting request.

Specified by:

getAppointmentReplyTime in interface ExchangeMeeting

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

getAppointmentSequenceNumber

int getAppointmentSequenceNumber()
                                 throws ExchangeServiceException

Returns the sequence number of a version of an appointment.

Specified by:

getAppointmentSequenceNumber in interface ExchangeMeeting

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

clearRecurrencePattern

void clearRecurrencePattern()
                            throws ExchangeServiceException

Clears the recurrence pattern of this item making it non-recurring. Only applicable to recurring master appointments (CalendarItemType.RecurringMaster). The changes are effective after this item is saved.

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

getRecurrencePattern

RecurrencePattern getRecurrencePattern()
                                       throws ExchangeServiceException

Returns the recurrence pattern of this item. Only applicable to recurring master appointments (CalendarItemType.RecurringMaster).

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

getRecurrenceMaster

ExchangeCalendarItem getRecurrenceMaster()
                                         throws ExchangeServiceException

Returns the master of this occurrence of a recurring appointment. Only applicable to occurrences of a recurring appointment when getCalendarItemType() returns CalendarItemType.Occurrence.

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

getRecurrenceOccurrence

ExchangeCalendarItem getRecurrenceOccurrence(int occurrenceIndex)
                                             throws ExchangeServiceException

Returns the occurrence at the specified index of a recurring appointment. Only applicable to recurring master appointments when getCalendarItemType() returns CalendarItemType.RecurringMaster.

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

getConferenceType

int getConferenceType()
                      throws ExchangeServiceException

Returns the type of conferencing that is performed. Possible returned values are:

0: NetMeeting
1: NetShow
2: Chat

Specified by:

getConferenceType in interface ExchangeMeeting

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

setConferenceType

void setConferenceType(int conferenceType)
                       throws ExchangeServiceException

Sets the type of conferencing that is performed. Possible values are:

0: NetMeeting
1: NetShow
2: Chat

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

getAllowNewTimeProposal

boolean getAllowNewTimeProposal()
                                throws ExchangeServiceException

Returns true if a new meeting time can be proposed for this meeting by an attendee, false otherwise.

Specified by:

getAllowNewTimeProposal in interface ExchangeMeeting

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

setAllowNewTimeProposal

void setAllowNewTimeProposal(boolean allowNewTimeProposal)
                             throws ExchangeServiceException

Sets whether a new meeting time can be proposed for this meeting by an attendee.

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

isOnlineMeeting

boolean isOnlineMeeting()
                        throws ExchangeServiceException

Returns true if this meeting is online, false otherwise.

Specified by:

isOnlineMeeting in interface ExchangeMeeting

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

setIsOnlineMeeting

void setIsOnlineMeeting(boolean isOnlineMeeting)
                        throws ExchangeServiceException

Sets whether this meeting is online.

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

getMeetingWorkspaceUrl

java.lang.String getMeetingWorkspaceUrl()
                                        throws ExchangeServiceException

Returns the URL for the meeting workspace.

Specified by:

getMeetingWorkspaceUrl in interface ExchangeMeeting

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

setMeetingWorkspaceUrl

void setMeetingWorkspaceUrl(java.lang.String meetingWorkspaceUrl)
                            throws ExchangeServiceException

Sets the URL for the meeting workspace.

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

getNetShowUrl

java.lang.String getNetShowUrl()
                               throws ExchangeServiceException

Returns the URL for a Microsoft NetShow online meeting.

Specified by:

getNetShowUrl in interface ExchangeMeeting

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

setNetShowUrl

void setNetShowUrl(java.lang.String netShowUrl)
                   throws ExchangeServiceException

Sets the URL for a Microsoft NetShow online meeting.

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

saveOnly

void saveOnly()
              throws ExchangeServiceException

Saves changes made to this item in the Exchange store without sending meeting invitations, cancellations or updates to attendees. In case of a conflict, the item won't be saved and an exception will be thrown by this method.

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

saveOnly

void saveOnly(boolean overwriteIfConflict)
              throws ExchangeServiceException

Saves changes made to this item in the Exchange store without sending meeting invitations, cancellations or updates to attendees.

Parameters:

overwriteIfConflict - if true and a conflict occurs the item will be always overwritten, otherwise an exception will be thrown in case of a conflict.

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

save

void save()
          throws ExchangeServiceException

Saves all the changes made to this item in the Exchange store.

In case of a meeting, invitation or update requests will be sent to all attendees. The sent request will be saved locally in the Sent Items folder.

If a conflict occurs, the item won't be saved and an exception will be thrown by this method.

Specified by:

save in interface ExchangeItem

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

save

void save(boolean overwriteIfConflict)
          throws ExchangeServiceException

Saves all the changes made to this item in the Exchange store.

In case of a meeting, invitation or update requests will be sent to all attendees. The sent request will be saved locally in the Sent Items folder.

Specified by:

save in interface ExchangeItem

Parameters:

overwriteIfConflict - if true and a conflict occurs the item will be always overwritten, otherwise an exception will be thrown in case of a conflict.

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

save

void save(boolean overwriteIfConflict,
          boolean notifyOnlyChangedAttendees)
          throws ExchangeServiceException

Saves all the changes made to this item in the Exchange store.

Parameters:

overwriteIfConflict - if true and a conflict occurs the item will be always overwritten, otherwise an exception will be thrown in case of a conflict.

notifyOnlyChangedAttendees - if true only changed attendees will receive a meeting invitation or update request, otherwise all attendees will receive the request.

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

save

void save(boolean overwriteIfConflict,
          boolean notifyOnlyChangedAttendees,
          boolean doNotSaveSentMeetingRequestCopy)
          throws ExchangeServiceException

Saves all the changes made to this item in the Exchange store.

Parameters:

overwriteIfConflict - if true and a conflict occurs the item will be always overwritten, otherwise an exception will be thrown in case of a conflict.

notifyOnlyChangedAttendees - if true only changed attendees will receive a meeting invitation or update request, otherwise all attendees will receive the request.

doNotSaveSentMeetingRequestCopy - if true a copy of the sent request won't be saved in the Sent Items folder, otherwise a copy will be saved.

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

deleteOnly

void deleteOnly(boolean moveToDeletedItems)
                throws ExchangeServiceException

Deletes this item.

In case of a meeting, cancellation updates won't be sent to attendees.

Parameters:

moveToDeletedItems - specifies whether the item is simply moved to the Deleted Items folder or definitely deleted.

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

delete

void delete(boolean moveToDeletedItems)
            throws ExchangeServiceException

Deletes this item.

In case of a meeting, cancellation updates will be sent to attendees. The sent request will be saved locally in the Sent Items folder.

Specified by:

delete in interface ExchangeItem

Parameters:

moveToDeletedItems - specifies whether the item is simply moved to the Deleted Items folder or definitely deleted.

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.

delete

void delete(boolean moveToDeletedItems,
            boolean doNotSaveSentMeetingRequestCopy)
            throws ExchangeServiceException

Deletes this item.

In case of a meeting, cancellation updates will be sent to attendees.

Parameters:

moveToDeletedItems - specifies whether the item is simply moved to the Deleted Items folder or definitely deleted.

doNotSaveSentMeetingRequestCopy - if true a copy of the sent request won't be saved in the Sent Items folder, otherwise a copy will be saved.

Throws:

ExchangeServiceException - if any errors occur during the communication with Exchange.