Moyosoft Products | Services | Download | Contact us    
Java Bridge to Exchange
Products  >  Java Bridge to Exchange  >  API Reference    
API Reference
   
Overview  |  
Classic JavaDoc

Interface ExchangeCalendarItem

com.moyosoft.exchange.calendar.ExchangeCalendarItem

Implemented Interfaces:

public interface ExchangeCalendarItem implements ExchangeItem, ExchangeMeeting

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

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

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

Example code that displays appointments for a specific date span:

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

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

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

See Also:

Methods

void
addOptionalAttendee (String optionalAttendeeEmailAddress)
Adds a new optional attendee to the current optional attendees list. The specified String is the new attendee's e-mail address.
void
addRequiredAttendee (String requiredAttendeeEmailAddress)
Adds a new required attendee to the current required attendees list. The specified String is the new attendee's e-mail address.
void
addResource (String resourceEmailAddress)
Adds a new resource to the current resources list. The specified String is the new resource's e-mail address.
void
clearOptionalAttendees ()
void
clearRecurrencePattern ()
Clears the recurrence pattern of this item making it non-recurring. Only applicable to recurring master appointments (com.moyosoft.exchange.calendar.CalendarItemType#RecurringMaster). The changes are effective after this item is saved.
void
clearRequiredAttendees ()
void
clearResources ()
void
delete (boolean moveToDeletedItems)
Deletes this item. In case of a meeting, cancellation updates will be sent to attendees. The sent request will be saved locally in the Sent Items folder.
void
delete (boolean moveToDeletedItems, boolean doNotSaveSentMeetingRequestCopy)
Deletes this item. In case of a meeting, cancellation updates will be sent to attendees.
void
deleteOnly (boolean moveToDeletedItems)
Deletes this item. In case of a meeting, cancellation updates won't be sent to attendees.
int
getAdjacentMeetingCount ()
Returns the total number of calendar items that are adjacent to this meeting's time.
java.util.List
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.
getCalendarItemType ()
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: Th ... more >
int
getConferenceType ()
Returns the type of conferencing that is performed. Possible returned values are: 0: NetMeeting 1: NetShow 2: Chat
int
getConflictingMeetingCount ()
Returns the number of meetings that conflict with this calendar item.
java.util.List
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.
String
getDuration ()
Returns the duration of this calendar item.
java.util.Date
getEnd ()
Returns the end date and time of this calendar item. Applies only to a single occurrence of a calendar item.
getFreeBusyStatus ()
Returns the free/busy status of this calendar item.
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.
String
getMeetingWorkspaceUrl ()
Returns the URL for the meeting workspace.
getMyResponseType ()
Returns the status of the response for this calendar item.
String
getNetShowUrl ()
Returns the URL for a Microsoft NetShow online meeting.
java.util.List
getOptionalAttendees ()
Returns a list of the optional attendees for this meeting. The returned list may be null or empty if there are no optional attendees.
String
getOrganizerEmailAddress ()
Returns the e-mail address of the organizer of this meeting.
getOrganizerMailbox ()
Returns the mailbox of the organizer of this meeting.
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.
getRecurrenceMaster ()
Returns the master of this occurrence of a recurring appointment. Only applicable to occurrences of a recurring appointment when getCalendarItemType() returns CalendarItemType.Occurrence.
getRecurrenceOccurrence (int occurrenceIndex)
Returns the occurrence at the specified index of a recurring appointment. Only applicable to recurring master appointments when getCalendarItemType() returns CalendarItemType.RecurringMaster.
getRecurrencePattern ()
Returns the recurrence pattern of this item. Only applicable to recurring master appointments (com.moyosoft.exchange.calendar.CalendarItemType#RecurringMaster).
java.util.List
getRequiredAttendees ()
Returns a list of the required attendees for this meeting. The returned list may be null or empty if there are no required attendees.
java.util.List
getResources ()
Returns a list of the resources for this meeting. The returned list may be null or empty if there are no resources scheduled.
java.util.Date
getStart ()
Returns the start date and time of this calendar item. Applies only to a single occurrence of a calendar item.
String
getTimeZone ()
Returns a textual description of a time zone.
String
getUid ()
Returns an UID uniquely identifying a calendar item.
String
getWhen ()
Returns textual information about when this appointment or meeting occurs.
boolean
isAllDayEvent ()
Returns true if this item is an all-day event; false otherwise.
boolean
isCancelled ()
Returns true if this meeting or appointment has been canceled, false otherwise.
boolean
isMeeting ()
Returns true if this calendar item is a meeting, false if it's an appointment.
boolean
isOnlineMeeting ()
Returns true if this meeting is online, false otherwise.
boolean
isRecurring ()
Returns true if this calendar item is part of a recurring item, false otherwise.
boolean
isResponseRequested ()
Indicates whether a response is required.
void
save ()
Saves all the changes made to this item in the Exchange store. In case of a meeting, invitation or update requests will be sent to all attendees. The sent request will be saved locally in the Sent Items folder. If a conflict occurs, the item won't be saved and an exception will be ... more >
void
save (boolean overwriteIfConflict)
Saves all the changes made to this item in the Exchange store. In case of a meeting, invitation or update requests will be sent to all attendees. The sent request will be saved locally in the Sent Items folder.
void
save (boolean overwriteIfConflict, boolean notifyOnlyChangedAttendees)
Saves all the changes made to this item in the Exchange store.
void
save (boolean overwriteIfConflict, boolean notifyOnlyChangedAttendees, boolean doNotSaveSentMeetingRequestCopy)
Saves all the changes made to this item in the Exchange store.
void
saveOnly ()
Saves changes made to this item in the Exchange store without sending meeting invitations, cancellations or updates to attendees. In case of a conflict, the item won't be saved and an exception will be thrown by this method.
void
saveOnly (boolean overwriteIfConflict)
Saves changes made to this item in the Exchange store without sending meeting invitations, cancellations or updates to attendees.
void
setAllowNewTimeProposal (boolean allowNewTimeProposal)
Sets whether a new meeting time can be proposed for this meeting by an attendee.
void
setConferenceType (int conferenceType)
Sets the type of conferencing that is performed. Possible values are: 0: NetMeeting 1: NetShow 2: Chat
void
setDateTimeStamp (java.util.Date dateTimeStamp)
void
setEnd (java.util.Date end)
Sets the end date and time of this calendar item. Applies only to a single occurrence of a calendar item.
void
setFreeBusyStatus (FreeBusyStatus freeBusyStatus)
Sets the free/busy status of this calendar item.
void
setIsAllDayEvent (boolean isAllDayEvent)
Sets whether this item is an all-day event or not.
void
setIsCancelled (boolean isCancelled)
Sets whether this calendar item is canceled or not.
void
setIsOnlineMeeting (boolean isOnlineMeeting)
Sets whether this meeting is online.
void
setIsResponseRequested (boolean isResponseRequested)
Sets whether a response is required.
void
setLocation (String location)
Sets the location of this calendar item.
void
setMeetingTimeZoneName (String name)
Deprecated - Use the method setStartTimeZone instead. Sets the TimeZone name for this calendar item. Only supported by Exchange 2007.
void
setMeetingWorkspaceUrl (String meetingWorkspaceUrl)
Sets the URL for the meeting workspace.
void
setMyResponseType (ResponseType myResponseType)
Sets the status of the response for this calendar item.
void
setNetShowUrl (String netShowUrl)
Sets the URL for a Microsoft NetShow online meeting.
void
setOptionalAttendee (String optionalAttendeeEmailAddress)
Sets a single optional attendee for this meeting. The specified String is the attendee's e-mail address and can be null or empty to specify that there's no optional attendees. To set multiple optional attendees use the method setOptionalAttendees(List). To add an attendee to the cur ... more >
void
setOptionalAttendees (java.util.List optionalAttendeesEmailAddresses)
Sets the list of optional attendees for this meeting. The list can be null or empty to specify that there's no optional attendees.
void
setRecurrenceId (java.util.Date recurrenceId)
The recurrence ID is used to identify a specific instance of a recurring calendar item.
void
setRequiredAttendee (String requiredAttendeeEmailAddress)
Sets a single required attendee for this meeting. The specified String is the attendee's e-mail address and can be null or empty to specify that there's no required attendees. To set multiple required attendees use the method setRequiredAttendees(List). To add an attendee to the cur ... more >
void
setRequiredAttendees (java.util.List requiredAttendeesEmailAddresses)
Sets the list of required attendees for this meeting. The list can be null or empty to specify that there's no required attendees.
void
setResource (String resourceEmailAddress)
Sets a single resource scheduled for this meeting. The specified String is the resource's e-mail address and can be null or empty to specify that there's no resources needed. To set multiple resources use the method setResources(List). To add a resource to the current list, use the ... more >
void
setResources (java.util.List resourcesEmailAddresses)
Sets the list of resources for this meeting. The list can be null or empty to specify that there's no resources needed.
void
setStart (java.util.Date start)
Sets the start date and time of this calendar item. Applies only to a single occurrence of a calendar item.
void
setStartTimeZone (java.util.TimeZone timeZone)
void
setWhen (String when)
Sets information about when this calendar item occurs.

Community comments



Powered by JavaDocPlus