|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectmicrosoft.exchange.webservices.data.ServiceObject
microsoft.exchange.webservices.data.Item
microsoft.exchange.webservices.data.Appointment
public class Appointment
Represents an appointment or a meeting. Properties available on appointments are defined in the AppointmentSchema class.
Constructor Summary | |
---|---|
|
Appointment(ExchangeService service)
Initializes an unsaved local instance of Appointment". |
protected |
Appointment(ItemAttachment parentAttachment,
boolean isNew)
Initializes a new instance of Appointment. |
Method Summary | |
---|---|
CalendarActionResults |
accept(boolean sendResponse)
Accepts the meeting. |
CalendarActionResults |
acceptTentatively(boolean sendResponse)
Tentatively accepts the meeting. |
static Appointment |
bind(ExchangeService service,
ItemId id)
Binds to an existing appointment and loads its first class properties. |
static Appointment |
bind(ExchangeService service,
ItemId id,
PropertySet propertySet)
Binds to an existing appointment and loads the specified set of properties. |
static Appointment |
bindToOccurrence(ExchangeService service,
ItemId recurringMasterId,
int occurenceIndex)
Binds to an existing appointment and loads its first class properties. |
static Appointment |
bindToOccurrence(ExchangeService service,
ItemId recurringMasterId,
int occurenceIndex,
PropertySet propertySet)
Binds to an existing appointment and loads its first class properties. |
static Appointment |
bindToRecurringMaster(ExchangeService service,
ItemId occurrenceId)
Binds to the master appointment of a recurring series and loads its first class properties. |
static Appointment |
bindToRecurringMaster(ExchangeService service,
ItemId occurrenceId,
PropertySet propertySet)
Binds to the master appointment of a recurring series and loads its first class properties. |
CalendarActionResults |
cancelMeeting()
Cancels the meeting and sends cancellation messages to all attendees. |
CalendarActionResults |
cancelMeeting(java.lang.String cancellationMessageText)
Cancels the meeting and sends cancellation messages to all attendees. |
AcceptMeetingInvitationMessage |
createAcceptMessage(boolean tentative)
Creates a local meeting acceptance message that can be customized and sent. |
CancelMeetingMessage |
createCancelMeetingMessage()
Creates a local meeting acceptance message that can be customized and sent. |
DeclineMeetingInvitationMessage |
createDeclineMessage()
Creates a local meeting declination message that can be customized and sent. |
ResponseMessage |
createForward()
Creates a forward message from this appointment. |
ResponseMessage |
createReply(boolean replyAll)
Creates a reply response to the organizer and/or attendees of the meeting. |
CalendarActionResults |
decline(boolean sendResponse)
Declines the meeting invitation. |
void |
delete(DeleteMode deleteMode,
SendCancellationsMode sendCancellationsMode)
Deletes this appointment. |
void |
forward(MessageBody bodyPrefix,
EmailAddress... toRecipients)
Forwards the appointment. |
void |
forward(MessageBody bodyPrefix,
java.lang.Iterable<EmailAddress> toRecipients)
Forwards the appointment. |
java.util.Date |
gaetICalDateTimeStmp()
Gets the ICalendar DateTimeStamp. |
java.lang.Integer |
getAdjacentMeetingCount()
Gets the number of calendar entries that are adjacent to this appointment in the authenticated user's calendar. |
ItemCollection<Appointment> |
getAdjacentMeetings()
Gets a list of meetings that conflict with this appointment in the authenticated user's calendar. |
java.lang.Boolean |
getAllowNewTimeProposal()
Gets a value indicating whether new time proposals are allowed for attendees of this meeting. |
java.util.Date |
getAppointmentReplyTime()
Gets the time when the attendee replied to the meeting request. |
java.lang.Integer |
getAppointmentSequenceNumber()
Gets the sequence number of this appointment. |
java.lang.Integer |
getAppointmentState()
Gets the state of this appointment. |
AppointmentType |
getAppointmentType()
Gets a value indicating the type of this appointment. |
java.lang.Integer |
getConferenceType()
Gets the type of conferencing that will be used during the meeting. |
java.lang.Integer |
getConflictingMeetingCount()
Gets the number of calendar entries that conflict with this appointment in the authenticated user's calendar. |
ItemCollection<Appointment> |
getConflictingMeetings()
Gets a list of meetings that conflict with this appointment in the authenticated user's calendar. |
protected SendCancellationsMode |
getDefaultSendCancellationsMode()
Gets the default setting for sending cancellations on Delete. |
protected SendInvitationsMode |
getDefaultSendInvitationsMode()
Gets the default settings for sending invitations on Save. |
protected SendInvitationsOrCancellationsMode |
getDefaultSendInvitationsOrCancellationsMode()
Gets the default settings for sending invitations on Save. |
DeletedOccurrenceInfoCollection |
getDeletedOccurrences()
Gets a list of deleted occurrences for this meeting. |
TimeSpan |
getDuration()
Gets the duration of this appointment. |
java.util.Date |
getEnd()
Gets or sets the end time of the appointment. |
TimeZoneDefinition |
getEndTimeZone()
Gets the start time zone. |
OccurrenceInfo |
getFirstOccurrence()
Gets an OccurrenceInfo identifying the first occurrence of this meeting. |
java.util.Date |
getICalRecurrenceId()
Gets the ICalendar RecurrenceId. |
java.lang.String |
getICalUid()
Gets the ICalendar Uid. |
java.lang.Boolean |
getIsAllDayEvent()
Gets a value indicating whether this appointment is an all day event. |
java.lang.Boolean |
getIsCancelled()
Gets a value indicating whether the appointment has been cancelled. |
protected boolean |
getIsCustomDateTimeScopingRequired()
Determines whether properties defined with ScopedDateTimePropertyDefinition require custom time zone scoping. |
java.lang.Boolean |
getIsMeeting()
Gets a value indicating whether the appointment is a meeting. |
java.lang.Boolean |
getIsOnlineMeeting()
Gets a value indicating whether this is an online meeting. |
java.lang.Boolean |
getIsRecurring()
Gets a value indicating whether the appointment is recurring. |
java.lang.Boolean |
getIsResponseRequested()
Gets a value indicating whether responses are requested when invitations are sent for this meeting. |
OccurrenceInfo |
getLastOccurrence()
Gets an OccurrenceInfo identifying the first occurrence of this meeting. |
LegacyFreeBusyStatus |
getLegacyFreeBusyStatus()
Gets a value indicating the free/busy status of the owner of this appointment. |
java.lang.String |
getLocation()
Gets the location of this appointment. |
java.lang.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 this appointment. |
Recurrence |
getRecurrence()
Gets the recurrence pattern for this appointment. |
AttendeeCollection |
getRequiredAttendees()
Gets a list of required attendees for this meeting. |
AttendeeCollection |
getResources()
Gets a list of resources for this meeting. |
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 the start time zone. |
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. |
void |
reply(MessageBody bodyPrefix,
boolean replyAll)
Replies to the organizer and/or the attendees of the meeting. |
void |
save(FolderId destinationFolderId,
SendInvitationsMode sendInvitationsMode)
Saves this appointment in the specified folder. |
void |
save(SendInvitationsMode sendInvitationsMode)
Saves this appointment in the Calendar folder. |
void |
save(WellKnownFolderName destinationFolderName,
SendInvitationsMode sendInvitationsMode)
Saves this appointment in the specified folder. |
void |
setAllowNewTimeProposal(java.lang.Boolean value)
Sets the allow new time proposal. |
void |
setConferenceType(java.lang.Integer value)
Sets the conference type. |
void |
setEnd(java.util.Date value)
Sets the end. |
void |
setEndTimeZone(TimeZoneDefinition value)
Sets the start time zone. |
void |
setICalUid(java.lang.String value)
Sets the ICalendar Uid. |
void |
setIsAllDayEvent(java.lang.Boolean value)
Sets the checks if is all day event. |
void |
setIsOnlineMeeting(java.lang.Boolean value)
Sets the checks if is online meeting. |
void |
setIsResponseRequested(java.lang.Boolean value)
Sets the checks if is response requested. |
void |
setLegacyFreeBusyStatus(LegacyFreeBusyStatus value)
Sets the legacy free busy status. |
void |
setLocation(java.lang.String value)
Sets the location. |
void |
setMeetingWorkspaceUrl(java.lang.String value)
Sets the meeting workspace url. |
void |
setNetShowUrl(java.lang.String value)
Sets the net show url. |
void |
setRecurrence(Recurrence value)
Sets the recurrence. |
void |
setStart(java.util.Date value)
Sets the start. |
void |
setStartTimeZone(TimeZoneDefinition value)
Sets the start time zone. |
void |
update(ConflictResolutionMode conflictResolutionMode,
SendInvitationsOrCancellationsMode sendInvitationsOrCancellationsMode)
Applies the local changes that have been made to this appointment. |
protected void |
validate()
Validates this instance. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Appointment(ExchangeService service) throws java.lang.Exception
service
- The ExchangeService instance to which this appointmtnt is
bound.
java.lang.Exception
- the exceptionprotected Appointment(ItemAttachment parentAttachment, boolean isNew) throws java.lang.Exception
parentAttachment
- the parent attachmentisNew
- If true, attachment is new.
java.lang.Exception
- the exceptionMethod Detail |
---|
public static Appointment bind(ExchangeService service, ItemId id, PropertySet propertySet) throws java.lang.Exception
service
- the serviceid
- the idpropertySet
- the property set
java.lang.Exception
- the exceptionpublic static Appointment bind(ExchangeService service, ItemId id) throws java.lang.Exception
service
- the serviceid
- the id
java.lang.Exception
- the exceptionpublic static Appointment bindToOccurrence(ExchangeService service, ItemId recurringMasterId, int occurenceIndex) throws java.lang.Exception
service
- the servicerecurringMasterId
- the recurring master idoccurenceIndex
- the occurence index
java.lang.Exception
- the exceptionpublic static Appointment bindToOccurrence(ExchangeService service, ItemId recurringMasterId, int occurenceIndex, PropertySet propertySet) throws java.lang.Exception
service
- the servicerecurringMasterId
- the recurring master idoccurenceIndex
- the occurence indexpropertySet
- the property set
java.lang.Exception
- the exceptionpublic static Appointment bindToRecurringMaster(ExchangeService service, ItemId occurrenceId) throws java.lang.Exception
service
- the serviceoccurrenceId
- the occurrence id
java.lang.Exception
- the exceptionpublic static Appointment bindToRecurringMaster(ExchangeService service, ItemId occurrenceId, PropertySet propertySet) throws java.lang.Exception
service
- the serviceoccurrenceId
- the occurrence idpropertySet
- the property set
java.lang.Exception
- the exceptionprotected ServiceObjectSchema getSchema()
getSchema
in class Item
protected ExchangeVersion getMinimumRequiredServerVersion()
getMinimumRequiredServerVersion
in class Item
protected boolean getIsCustomDateTimeScopingRequired()
getIsCustomDateTimeScopingRequired
in class ServiceObject
protected void validate() throws java.lang.Exception
validate
in class Item
java.lang.Exception
public ResponseMessage createReply(boolean replyAll) throws java.lang.Exception
replyAll
- the reply all
java.lang.Exception
- the exceptionpublic void reply(MessageBody bodyPrefix, boolean replyAll) throws java.lang.Exception
bodyPrefix
- the body prefixreplyAll
- the reply all
java.lang.Exception
- the exceptionpublic ResponseMessage createForward() throws java.lang.Exception
java.lang.Exception
- the exceptionpublic void forward(MessageBody bodyPrefix, EmailAddress... toRecipients) throws java.lang.Exception
bodyPrefix
- the body prefixtoRecipients
- the to recipients
java.lang.Exception
- the exceptionpublic void forward(MessageBody bodyPrefix, java.lang.Iterable<EmailAddress> toRecipients) throws java.lang.Exception
bodyPrefix
- the body prefixtoRecipients
- the to recipients
java.lang.Exception
- the exceptionpublic void save(WellKnownFolderName destinationFolderName, SendInvitationsMode sendInvitationsMode) throws java.lang.Exception
destinationFolderName
- the destination folder namesendInvitationsMode
- the send invitations mode
java.lang.Exception
- the exceptionpublic void save(FolderId destinationFolderId, SendInvitationsMode sendInvitationsMode) throws java.lang.Exception
destinationFolderId
- the destination folder idsendInvitationsMode
- the send invitations mode
java.lang.Exception
- the exceptionpublic void save(SendInvitationsMode sendInvitationsMode) throws java.lang.Exception
sendInvitationsMode
- the send invitations mode
java.lang.Exception
- the exceptionpublic void update(ConflictResolutionMode conflictResolutionMode, SendInvitationsOrCancellationsMode sendInvitationsOrCancellationsMode) throws java.lang.Exception
conflictResolutionMode
- the conflict resolution modesendInvitationsOrCancellationsMode
- the send invitations or cancellations mode
java.lang.Exception
- the exceptionpublic void delete(DeleteMode deleteMode, SendCancellationsMode sendCancellationsMode) throws java.lang.Exception
deleteMode
- the delete modesendCancellationsMode
- the send cancellations mode
java.lang.Exception
- the exceptionpublic AcceptMeetingInvitationMessage createAcceptMessage(boolean tentative) throws java.lang.Exception
tentative
- the tentative
java.lang.Exception
- the exceptionpublic CancelMeetingMessage createCancelMeetingMessage() throws java.lang.Exception
java.lang.Exception
- the exceptionpublic DeclineMeetingInvitationMessage createDeclineMessage() throws java.lang.Exception
java.lang.Exception
- the exceptionpublic CalendarActionResults accept(boolean sendResponse) throws java.lang.Exception
sendResponse
- the send response
java.lang.Exception
- the exceptionpublic CalendarActionResults acceptTentatively(boolean sendResponse) throws java.lang.Exception
sendResponse
- the send response
java.lang.Exception
- the exceptionprotected CalendarActionResults internalAccept(boolean tentative, boolean sendResponse) throws java.lang.Exception
tentative
- the tentativesendResponse
- the send response
java.lang.Exception
- the exceptionpublic CalendarActionResults cancelMeeting() throws java.lang.Exception
java.lang.Exception
- the exceptionpublic CalendarActionResults cancelMeeting(java.lang.String cancellationMessageText) throws java.lang.Exception
cancellationMessageText
- the cancellation message text
java.lang.Exception
- the exceptionpublic CalendarActionResults decline(boolean sendResponse) throws java.lang.Exception
sendResponse
- the send response
java.lang.Exception
- the exceptionprotected SendCancellationsMode getDefaultSendCancellationsMode()
getDefaultSendCancellationsMode
in class Item
protected SendInvitationsMode getDefaultSendInvitationsMode()
getDefaultSendInvitationsMode
in class Item
protected SendInvitationsOrCancellationsMode getDefaultSendInvitationsOrCancellationsMode()
getDefaultSendInvitationsOrCancellationsMode
in class Item
public java.util.Date getStart() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic void setStart(java.util.Date value) throws java.lang.Exception
value
- the new start
java.lang.Exception
- the exceptionpublic java.util.Date getEnd() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic void setEnd(java.util.Date value) throws java.lang.Exception
value
- the new end
java.lang.Exception
- the exceptionpublic java.util.Date getOriginalStart() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic java.lang.Boolean getIsAllDayEvent() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic void setIsAllDayEvent(java.lang.Boolean value) throws java.lang.Exception
value
- the new checks if is all day event
java.lang.Exception
- the exceptionpublic LegacyFreeBusyStatus getLegacyFreeBusyStatus() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic void setLegacyFreeBusyStatus(LegacyFreeBusyStatus value) throws java.lang.Exception
value
- the new legacy free busy status
java.lang.Exception
- the exceptionpublic java.lang.String getLocation() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic void setLocation(java.lang.String value) throws java.lang.Exception
value
- the new location
java.lang.Exception
- the exceptionpublic java.lang.String getWhen() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic java.lang.Boolean getIsMeeting() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic java.lang.Boolean getIsCancelled() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic java.lang.Boolean getIsRecurring() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic java.lang.Boolean getMeetingRequestWasSent() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic java.lang.Boolean getIsResponseRequested() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic void setIsResponseRequested(java.lang.Boolean value) throws java.lang.Exception
value
- the new checks if is response requested
java.lang.Exception
- the exceptionpublic AppointmentType getAppointmentType() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic MeetingResponseType getMyResponseType() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic EmailAddress getOrganizer() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic AttendeeCollection getRequiredAttendees() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic AttendeeCollection getOptionalAttendees() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic AttendeeCollection getResources() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic java.lang.Integer getConflictingMeetingCount() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic java.lang.Integer getAdjacentMeetingCount() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic ItemCollection<Appointment> getConflictingMeetings() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic ItemCollection<Appointment> getAdjacentMeetings() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic TimeSpan getDuration() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic java.lang.String getTimeZone() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic java.util.Date getAppointmentReplyTime() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic java.lang.Integer getAppointmentSequenceNumber() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic java.lang.Integer getAppointmentState() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic Recurrence getRecurrence() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic void setRecurrence(Recurrence value) throws java.lang.Exception
value
- the new recurrence
java.lang.Exception
- the exceptionpublic OccurrenceInfo getFirstOccurrence() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic OccurrenceInfo getLastOccurrence() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic OccurrenceInfoCollection getModifiedOccurrences() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic DeletedOccurrenceInfoCollection getDeletedOccurrences() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic TimeZoneDefinition getStartTimeZone() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic void setStartTimeZone(TimeZoneDefinition value) throws java.lang.Exception
value
- the new start time zone
java.lang.Exception
- the exceptionpublic TimeZoneDefinition getEndTimeZone() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic void setEndTimeZone(TimeZoneDefinition value) throws java.lang.Exception
value
- the new end time zone
java.lang.Exception
- the exceptionpublic java.lang.Integer getConferenceType() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic void setConferenceType(java.lang.Integer value) throws java.lang.Exception
value
- the new conference type
java.lang.Exception
- the exceptionpublic java.lang.Boolean getAllowNewTimeProposal() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic void setAllowNewTimeProposal(java.lang.Boolean value) throws java.lang.Exception
value
- the new allow new time proposal
java.lang.Exception
- the exceptionpublic java.lang.Boolean getIsOnlineMeeting() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic void setIsOnlineMeeting(java.lang.Boolean value) throws java.lang.Exception
value
- the new checks if is online meeting
java.lang.Exception
- the exceptionpublic java.lang.String getMeetingWorkspaceUrl() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic void setMeetingWorkspaceUrl(java.lang.String value) throws java.lang.Exception
value
- the new meeting workspace url
java.lang.Exception
- the exceptionpublic java.lang.String getNetShowUrl() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic void setNetShowUrl(java.lang.String value) throws java.lang.Exception
value
- the new net show url
java.lang.Exception
- the exceptionpublic java.lang.String getICalUid() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic void setICalUid(java.lang.String value) throws java.lang.Exception
value
- the i cal uid
java.lang.Exception
public java.util.Date getICalRecurrenceId() throws ServiceLocalException
ServiceLocalException
- the service local exceptionpublic java.util.Date gaetICalDateTimeStmp() throws ServiceLocalException
ServiceLocalException
- the service local exception
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |