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

Class MeetingRequest

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

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

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

All Implemented Interfaces:

ICalendarActionProvider

public class MeetingRequest
extends MeetingMessage
implements ICalendarActionProvider

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

Constructor Summary

Constructors

Constructor	Description
MeetingRequest(ExchangeService service)	Initializes a new instance of the class.
MeetingRequest(ItemAttachment parentAttachment)	Initializes a new instance of the class.

Method Summary

Modifier and Type	Method	Description
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 property.
static MeetingRequest	bind(ExchangeService service, ItemId id, PropertySet propertySet)	Binds to an existing meeting response and loads the specified set of property.
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.
Date	getAppointmentReplyTime()	Gets the time when the attendee replied to the meeting request.
int	getAppointmentSequenceNumber()	Gets the sequence number of this appointment.
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.
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.
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.
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 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.
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 time zone of the start property of this meeting request.
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.
LegacyFreeBusyStatus	legacyFreeBusyStatus()	Gets a value indicating the free/busy status of the owner of this appointment.
void	setEnd(Date value)	Sets the end.
void	setEndTimeZone(TimeZoneDefinition value)	Sets the start time zone.
void	setIsAllDayEvent(Boolean value)	Sets the checks if is all day event.
void	setLocation(String value)	Sets the location.
void	setStart(Date value)	Sets the start.
void	setStartTimeZone(TimeZoneDefinition value)	Sets the start time zone.

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

getAssociatedAppointmentId, getHasBeenProcessed, getICalDateTimeStamp, getICalRecurrenceId, getICalUid, getIsDelegated, getIsOutOfDate, getResponseType, setICalUid, setResponseType

Methods inherited from class microsoft.exchange.webservices.data.core.service.item.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.core.service.item.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, throwIfThisIsAttachment, update, validate

Methods inherited from class microsoft.exchange.webservices.data.core.service.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

public MeetingRequest(ItemAttachment parentAttachment)
               throws Exception

Initializes a new instance of the class.

Parameters:

parentAttachment - The parent attachment

Throws:

Exception - throws Exception

MeetingRequest

public MeetingRequest(ExchangeService service)
               throws Exception

Initializes a new instance of the class.

Parameters:

service - EWS service to which this object belongs.

Throws:

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

public 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

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

Specified by:

createAcceptMessage in interface ICalendarActionProvider

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.

Specified by:

createDeclineMessage in interface ICalendarActionProvider

Returns:

A DeclineMeetingInvitation representing the meeting declination message.

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 - Indicates whether to send a response to the organizer.

Returns:

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

Throws:

Exception - throws 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 - Indicates whether to send a response to the organizer.

Returns:

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

Throws:

Exception - throws Exception

internalAccept

protected CalendarActionResults internalAccept(boolean tentative,
                                               boolean sendResponse)
                                        throws 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 item that were created or modified as a results of this operation.

Throws:

Exception - throws 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 - Indicates whether to send a response to the organizer.

Returns:

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

Throws:

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 Date getStart()
              throws ServiceLocalException

Gets the start time of the appointment.

Returns:

the start

Throws:

ServiceLocalException - the service local exception

getEnd

public Date getEnd()
            throws ServiceLocalException

Gets the end time of the appointment.

Returns:

the end

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

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

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

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

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 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:

NumberFormatException - the number format exception

ServiceLocalException - the service local exception

getAdjacentMeetingCount

public int getAdjacentMeetingCount()
                            throws 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:

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 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 int getAppointmentSequenceNumber()
                                 throws NumberFormatException,
                                        ServiceLocalException

Gets the sequence number of this appointment.

Returns:

the appointment sequence number

Throws:

NumberFormatException - the number format exception

ServiceLocalException - the service local exception

getAppointmentState

public int getAppointmentState()
                        throws NumberFormatException,
                               ServiceLocalException

Gets the state of this appointment.

Returns:

the appointment state

Throws:

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

setStartTimeZone

public void setStartTimeZone(TimeZoneDefinition value)
                      throws Exception

Sets the start time zone.

Parameters:

value - the new start time zone

Throws:

Exception - the 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 int getConferenceType()
                      throws NumberFormatException,
                             ServiceLocalException

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

Returns:

the conference type

Throws:

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 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 String getNetShowUrl()
                     throws ServiceLocalException

Gets the URL of the Microsoft NetShow online meeting.

Returns:

the net show url

Throws:

ServiceLocalException - the service local exception