com.moyosoft.exchange.calendar
Interface ExchangeMeeting

All Known Subinterfaces:

ExchangeCalendarItem, ExchangeMeetingRequest

public interface ExchangeMeeting

Contains information of a meeting either as a calendar item or a received meeting request message.

Method Summary

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.
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	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	respond(ResponseType responseType) Sends a response to the meeting organizer for this meeting.

Method Detail

getUid

java.lang.String getUid()
                        throws ExchangeServiceException

Returns an UID uniquely identifying a calendar item.

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.

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.

Throws:

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

Throws:

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

isResponseRequested

boolean isResponseRequested()
                            throws ExchangeServiceException

Indicates 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.

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.

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.

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.

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.

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.

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.

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.

Throws:

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

getConflictingMeetingCount

int getConflictingMeetingCount()
                               throws ExchangeServiceException

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

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.

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.

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.

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.

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.

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.

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.

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

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.

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.

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.

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.

Throws:

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

respond

void respond(ResponseType responseType)
             throws ExchangeServiceException

Sends a response to the meeting organizer for this meeting. Only Tentative, Accept or Decline are valid response types.

Throws:

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