microsoft.exchange.webservices.data
Class MeetingRequest

java.lang.Object
  extended by microsoft.exchange.webservices.data.ServiceObject
      extended by microsoft.exchange.webservices.data.Item
          extended by microsoft.exchange.webservices.data.EmailMessage
              extended by microsoft.exchange.webservices.data.MeetingMessage
                  extended by microsoft.exchange.webservices.data.MeetingRequest

public class MeetingRequest
extends MeetingMessage

Represents a meeting request that an attendee can accept or decline. Properties available on meeting requests are defined in the MeetingRequestSchema class.


Constructor Summary
protected MeetingRequest(ExchangeService service)
          Initializes a new instance of the class.
protected MeetingRequest(ItemAttachment parentAttachment)
          Initializes a new instance of the class.
 
Method Summary
 CalendarActionResults accept(boolean sendResponse)
          Accepts the meeting.
 CalendarActionResults acceptTentatively(boolean sendResponse)
          Tentatively accepts the meeting.
static MeetingRequest bind(ExchangeService service, ItemId id)
          Binds to an existing meeting response and loads the specified set of properties.
static MeetingRequest bind(ExchangeService service, ItemId id, PropertySet propertySet)
          Binds to an existing meeting response and loads the specified set of properties.
 AcceptMeetingInvitationMessage createAcceptMessage(boolean tentative)
          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.
 CalendarActionResults decline(boolean sendResponse)
          Declines the meeting invitation.
 int 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 are adjacent 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.
 int getAppoijntmentSequenceNumber()
          Gets the sequence number of this appointment.
 java.util.Date getAppointmentReplyTime()
          Gets the time when the attendee replied to the meeting request.
 int getAppointmentState()
          Gets the state of this appointment.
 AppointmentType getAppointmentType()
          Gets a value indicating the type of this appointment.
 int getConferenceType()
          Gets the type of conferencing that will be used during the meeting.
 int 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.
 DeletedOccurrenceInfoCollection getDeletedOccurrences()
          Gets a list of deleted occurrences for this meeting.
 TimeSpan getDuration()
          Gets the duration of this appointment.
 java.util.Date getEnd()
          Gets the end time of the appointment.
 TimeZoneDefinition getEndTimeZone()
          Gets time zone of the end property of this meeting request.
 OccurrenceInfo getFirstOccurrence()
          Gets an OccurrenceInfo identifying the first occurrence of this meeting.
 LegacyFreeBusyStatus getIntendedFreeBusyStatus()
          Gets the a value representing the intended free/busy status of the meeting.
 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.
 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 getIsRecurring()
          Gets a value indicating whether the appointment is recurring.
 OccurrenceInfo getLastOccurrence()
          Gets an OccurrenceInfo identifying the last occurrence of this meeting.
 java.lang.String getLocation()
          Gets the location of this appointment.
 MeetingRequestType getMeetingRequestType()
          Gets the type of this meeting request.
 boolean getMeetingRequestWasSent()
          Gets a value indicating whether the meeting request has already been sent.
 java.lang.String getMeetingWorkspaceUrl()
          Gets the URL of the meeting workspace.
protected  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.
 java.lang.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.
 java.util.Date getOriginalStart()
          Gets the original start time of the appointment.
 Recurrence getRecurrence()
          Gets the recurrence pattern for this meeting request.
 AttendeeCollection getRequiredAttendees()
          Gets a list of required attendees for this meeting.
 AttendeeCollection getResources()
          Gets a list of resources for this meeting.
protected  ServiceObjectSchema getSchema()
          Internal method to return the schema associated with this type of object.
 java.util.Date getStart()
          Gets the start time of the appointment.
 TimeZoneDefinition getStartTimeZone()
          Gets time zone of the start property of this meeting request.
 java.lang.String getTimeZone()
          Gets the name of the time zone this appointment is defined in.
 java.lang.String getWhen()
          Gets a text indicating when this appointment occurs.
protected  CalendarActionResults internalAccept(boolean tentative, boolean sendResponse)
          Accepts the meeting.
 LegacyFreeBusyStatus legacyFreeBusyStatus()
          Gets a value indicating the free/busy status of the owner of this appointment.
 
Methods inherited from class microsoft.exchange.webservices.data.EmailMessage
createForward, createReply, forward, forward, getBccRecipients, getCcRecipients, getConversationIndex, getConversationTopic, getFrom, getInternetMessageId, getIsAssociated, getIsDeliveryReceiptRequested, getIsRead, getIsReadReceiptRequested, getIsResponseRequested, getReceivedBy, getReceivedRepresenting, getReferences, getReplyTo, getSender, getToRecipients, reply, send, sendAndSaveCopy, sendAndSaveCopy, sendAndSaveCopy, setFrom, setIsAssociated, setIsDeliveryReceiptRequested, setIsRead, setIsReadReceiptRequested, setIsResponseRequested, setReferences, setSender, suppressReadReceipt
 
Methods inherited from class microsoft.exchange.webservices.data.Item
copy, copy, delete, getAllowedResponseActions, getAttachments, getBody, getCategories, getConversationId, getCulture, getDateTimeCreated, getDateTimeReceived, getDateTimeSent, getDefaultAffectedTaskOccurrences, getDefaultSendCancellationsMode, getDefaultSendInvitationsMode, getDefaultSendInvitationsOrCancellationsMode, getDisplayCc, getDisplayTo, getEffectiveRights, getExtendedProperties, getHasAttachments, getId, getIdPropertyDefinition, getImportance, getInReplyTo, getInternetMessageHeaders, 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, setSubject, throwIfThisIsAttachment, update, validate
 
Methods inherited from class microsoft.exchange.webservices.data.ServiceObject
addServiceObjectChangedEvent, changed, clearChangeLog, clearServiceObjectChangedEvent, getChangeXmlElementName, getDeleteFieldXmlElementName, getIsCustomDateTimeScopingRequired, 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

MeetingRequest

protected MeetingRequest(ItemAttachment parentAttachment)
                  throws java.lang.Exception
Initializes a new instance of the class.

Parameters:
parentAttachment - The parent attachment
Throws:
java.lang.Exception - throws Exception

MeetingRequest

protected MeetingRequest(ExchangeService service)
                  throws java.lang.Exception
Initializes a new instance of the class.

Parameters:
service - EWS service to which this object belongs.
Throws:
java.lang.Exception - throws Exception
Method Detail

bind

public static MeetingRequest bind(ExchangeService service,
                                  ItemId id,
                                  PropertySet propertySet)
Binds to an existing meeting response and loads the specified set of properties. Calling this method results in a call to EWS.

Parameters:
service - The service to use to bind to the meeting request.
id - The Id of the meeting request to bind to.
propertySet - The set of properties to load.
Returns:
A MeetingResponse instance representing the meeting request corresponding to the specified Id.

bind

public static MeetingRequest bind(ExchangeService service,
                                  ItemId id)
Binds to an existing meeting response and loads the specified set of properties. Calling this method results in a call to EWS.

Parameters:
service - The service to use to bind to the meeting request.
id - The Id of the meeting request to bind to.
Returns:
A MeetingResponse instance representing the meeting request corresponding to the specified Id.

getSchema

protected ServiceObjectSchema getSchema()
Internal method to return the schema associated with this type of object.

Overrides:
getSchema in class MeetingMessage
Returns:
The schema associated with this type of object.

getMinimumRequiredServerVersion

protected ExchangeVersion getMinimumRequiredServerVersion()
Gets the minimum required server version.

Overrides:
getMinimumRequiredServerVersion in class MeetingMessage
Returns:
Earliest Exchange version in which this service object type is supported.

createAcceptMessage

public AcceptMeetingInvitationMessage createAcceptMessage(boolean tentative)
Creates a local meeting acceptance message that can be customized and sent.

Parameters:
tentative - Specifies whether the meeting will be tentatively accepted.
Returns:
An AcceptMeetingInvitationMessage representing the meeting acceptance message.

createDeclineMessage

public DeclineMeetingInvitationMessage createDeclineMessage()
Creates a local meeting declination message that can be customized and sent.

Returns:
A DeclineMeetingInvitation representing the meeting declination message.

accept

public CalendarActionResults accept(boolean sendResponse)
                             throws java.lang.Exception
Accepts the meeting. Calling this method results in a call to EWS.

Parameters:
sendResponse - Indicates whether to send a response to the organizer.
Returns:
A CalendarActionResults object containing the various items that were created or modified as a results of this operation.
Throws:
java.lang.Exception - throws Exception

acceptTentatively

public CalendarActionResults acceptTentatively(boolean sendResponse)
                                        throws java.lang.Exception
Tentatively accepts the meeting. Calling this method results in a call to EWS.

Parameters:
sendResponse - Indicates whether to send a response to the organizer.
Returns:
A CalendarActionResults object containing the various items that were created or modified as a results of this operation.
Throws:
java.lang.Exception - throws Exception

internalAccept

protected CalendarActionResults internalAccept(boolean tentative,
                                               boolean sendResponse)
                                        throws java.lang.Exception
Accepts the meeting.

Parameters:
tentative - True if tentative accept.
sendResponse - Indicates whether to send a response to the organizer.
Returns:
A CalendarActionResults object containing the various items that were created or modified as a results of this operation.
Throws:
java.lang.Exception - throws Exception

decline

public CalendarActionResults decline(boolean sendResponse)
                              throws java.lang.Exception
Declines the meeting invitation. Calling this method results in a call to EWS.

Parameters:
sendResponse - Indicates whether to send a response to the organizer.
Returns:
A CalendarActionResults object containing the various items that were created or modified as a results of this operation.
Throws:
java.lang.Exception - throws Exception

getMeetingRequestType

public MeetingRequestType getMeetingRequestType()
                                         throws ServiceLocalException
Gets the type of this meeting request.

Returns:
the meeting request type
Throws:
ServiceLocalException - the service local exception

getIntendedFreeBusyStatus

public LegacyFreeBusyStatus getIntendedFreeBusyStatus()
                                               throws ServiceLocalException
Gets the a value representing the intended free/busy status of the meeting.

Returns:
the intended free busy status
Throws:
ServiceLocalException - the service local exception

getStart

public java.util.Date getStart()
                        throws ServiceLocalException
Gets the start time of the appointment.

Returns:
the start
Throws:
ServiceLocalException - the service local exception

getEnd

public java.util.Date getEnd()
                      throws ServiceLocalException
Gets the end time of the appointment.

Returns:
the end
Throws:
ServiceLocalException - the service local exception

getOriginalStart

public java.util.Date getOriginalStart()
                                throws ServiceLocalException
Gets the original start time of the 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

legacyFreeBusyStatus

public LegacyFreeBusyStatus legacyFreeBusyStatus()
                                          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

getLocation

public java.lang.String getLocation()
                             throws ServiceLocalException
Gets the location of this appointment.

Returns:
the location
Throws:
ServiceLocalException - the service local exception

getWhen

public java.lang.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

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

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

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.

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 int getConflictingMeetingCount()
                               throws java.lang.NumberFormatException,
                                      ServiceLocalException
Gets the number of calendar entries that conflict with this appointment in the authenticated user's calendar.

Returns:
the conflicting meeting count
Throws:
java.lang.NumberFormatException - the number format exception
ServiceLocalException - the service local exception

getAdjacentMeetingCount

public int getAdjacentMeetingCount()
                            throws java.lang.NumberFormatException,
                                   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:
java.lang.NumberFormatException - the number format exception
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 are adjacent 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 java.lang.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 java.util.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

getAppoijntmentSequenceNumber

public int getAppoijntmentSequenceNumber()
                                  throws java.lang.NumberFormatException,
                                         ServiceLocalException
Gets the sequence number of this appointment.

Returns:
the appoijntment sequence number
Throws:
java.lang.NumberFormatException - the number format exception
ServiceLocalException - the service local exception

getAppointmentState

public int getAppointmentState()
                        throws java.lang.NumberFormatException,
                               ServiceLocalException
Gets the state of this appointment.

Returns:
the appointment state
Throws:
java.lang.NumberFormatException - the number format exception
ServiceLocalException - the service local exception

getRecurrence

public Recurrence getRecurrence()
                         throws ServiceLocalException
Gets the recurrence pattern for this meeting request.

Returns:
the recurrence
Throws:
ServiceLocalException - the service local 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 last 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 time zone of the start property of this meeting request.

Returns:
the start time zone
Throws:
ServiceLocalException - the service local exception

getEndTimeZone

public TimeZoneDefinition getEndTimeZone()
                                  throws ServiceLocalException
Gets time zone of the end property of this meeting request.

Returns:
the end time zone
Throws:
ServiceLocalException - the service local exception

getConferenceType

public int getConferenceType()
                      throws java.lang.NumberFormatException,
                             ServiceLocalException
Gets the type of conferencing that will be used during the meeting.

Returns:
the conference type
Throws:
java.lang.NumberFormatException - the number format exception
ServiceLocalException - the service local 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

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

getMeetingWorkspaceUrl

public java.lang.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

getNetShowUrl

public java.lang.String getNetShowUrl()
                               throws ServiceLocalException
Gets the URL of the Microsoft NetShow online meeting.

Returns:
the net show url
Throws:
ServiceLocalException - the service local exception