com.compoze.exchange.webdav
Class Appointment

java.lang.Object

  |

  +--com.compoze.exchange.webdav.AbstractItem

        |

        +--com.compoze.exchange.webdav.AbstractMessage

              |

              +--com.compoze.exchange.webdav.Appointment

All Implemented Interfaces:

java.lang.Cloneable, IItem, java.io.Serializable

public class Appointment

extends AbstractMessage

implements java.io.Serializable, java.lang.Cloneable

This class extends AbstractMessage to represent an item that is an appointment in the Exchange store.

The following table contains the properties defined in the Exchange store schema and mappings to their corresponding Java enumeration and methods:

Exchange Store Property	Property Enumeration	Java Methods
http://schemas.microsoft.com/mapi/id/{00062003-0000-0000-C000-000000000046}/x00008217	MapiProperty.APPOINTMENT_APPOINTMENT_STATUS	getResponseStatus() setResponseStatus(ResponseStatus)
http://schemas.microsoft.com/mapi/id/{00062003-0000-0000-C000-000000000046}/x00008218	MapiProperty.APPOINTMENT_RESPONSE_STATUS	getResponseStatus() setResponseStatus(ResponseStatus)
urn:schemas:calendar:busystatus	CalendarProperty.BUSY_STATUS	getBusyStatus() setBusyStatus(BusyStatus)
urn:schemas:calendar:created	CalendarProperty.CREATED	getCreated()
urn:schemas:calendar:descriptionurl	CalendarProperty.DESCRIPTION_URL	getDescriptionURL() setDescriptionURL(URL)
urn:schemas:calendar:dtend	CalendarProperty.DATE_END	getEndDate() setEndDate(Date)
urn:schemas:calendar:dtstart	CalendarProperty.DATE_START	getStartDate() setStartDate(Date)
urn:schemas:calendar:duration	CalendarProperty.DURATION	getDuration() setDuration(int)
urn:schemas:calendar:geolatitude	CalendarProperty.GEO_LATITUDE	getGeoLatitude() setGeoLatitude(double)
urn:schemas:calendar:geolongitude	CalendarProperty.GEO_LONGITUDE	getGeoLongitude() setGeoLongitude(double)
urn:schemas:calendar:instancetype	CalendarProperty.INSTANCE_TYPE	getInstanceType() setInstanceType(InstanceType)
urn:schemas:calendar:location	CalendarProperty.LOCATION	getLocation() setLocation(String)
urn:schemas:calendar:locationurl	CalendarProperty.LOCATION_URL	getLocationURL() setLocationURL(String)
urn:schemas:httpmail:priority	HttpMailProperty.PRIORITY	getPriority() setPriority(Priority)
urn:schemas:calendar:organizer	CalendarProperty.ORGANIZER	getOrganizer() setOrganizer(String)
urn:schemas:calendar:reminderoffset	CalendarProperty.REMINDER_OFFSET	getReminderOffset() setReminderOffset(int)
urn:schemas:calendar:replytime	CalendarProperty.REPLY_TIME	getReplyTime()
urn:schemas:calendar:responserequested	CalendarProperty.RESPONSE_REQUESTED	isResponseRequested() setResponseRequested(boolean)
urn:schemas:calendar:rrule	CalendarProperty.RECURRENCE_RULE	getRecurrencePattern() setRecurrencePattern(DateRecurrence)
http://schemas.microsoft.com/exchange/sensitivity	ExchangeProperty.SENSITIVITY	getSensitivity() setSensitivity(Sensitivity)
urn:schemas:calendar:timezone	CalendarProperty.TIME_ZONE	getTimeZone() setTimeZone(String)
urn:schemas:calendar:timezoneid	CalendarProperty.TIME_ZONE_ID	getTimeZoneID() setTimeZoneID(TimeZoneId)
urn:schemas:calendar:uid	CalendarProperty.APPOINTMENT_UID	getAppointmentUID() setAppointmentUID(String)
urn:schemas:httpmail:subject	HttpMailProperty.SUBJECT	getSubject() setSubject(String)
urn:schemas:mailheader:bcc	MailHeaderProperty.BCC	getResources() setResources(List)
urn:schemas:mailheader:cc	MailHeaderProperty.CC	getOptionalAttendees() setOptionalAttendees(List)
urn:schemas:mailheader:to	MailHeaderProperty.TO	getRequiredAttendees() setRequiredAttendees(List)

Below is an example of how to create an appointment:

   //	Add appointment
   Calendar calendar = Calendar.getInstance();
   calendar.add(Calendar.MINUTE, 5);
   Date startDate = calendar.getTime();

   calendar.add(Calendar.MINUTE, 30);
   Date endDate = calendar.getTime();

   CalendarFolder calendarFolder = m_session.getCalendarFolder();
   Appointments appointments = calendarFolder.getAppointments(startDate, endDate);

   Appointment appt = new Appointment("New appointment",
	new DateRange(startDate, endDate), TimeZoneId.EASTERN);
   appointment.setLocation("Appointment location");
   appointment.setBody("This appointment is non-recurring.");

   appointments.add(appt);
 

To create a recurring appointment, the following must be set:

The constructor Appointment(String, DateRange, DateRecurrence, TimeZoneId) is provided to allocate a recurring Appointment object.
Below is an example of how to create a recurring appointment:

   Calendar calendar = Calendar.getInstance();
   calendar.add(Calendar.MINUTE, 5);
   Date startDate = calendar.getTime();

   calendar.add(Calendar.MINUTE, 30);
   Date endDate = calendar.getTime();

   CalendarFolder calendarFolder = m_session.getCalendarFolder();
   Appointments appointments = calendarFolder.getAppointments(startDate, endDate);

   //	Recur every second week for 4 months
   calendar.add(Calendar.MONTH, 4);
   Date untilDate = calendar.getTime();
   DateRecurrence pattern = DateRecurrence.createEveryNWeeks(startDate, 2, untilDate);

   Appointment recurAppt = new Appointment("Recur every second week for four months",
	new DateRange(startDate, endDate),
	pattern,
	TimeZoneId.EASTERN);
   recurAppt.setLocation("Recurring appointment location");
   recurAppt.setBody("This appointment is recurring.");

   appointments.add(recurAppt);
 

See Also:

Serialized Form

Constructor Summary

Appointment(java.util.Date date, boolean bAllDay, TimeZoneId timeZoneID)
Constructor.

Appointment(java.util.Date startDate, java.util.Date endDate, TimeZoneId timeZoneID)
Constructor.

Appointment(java.util.Date startDate, java.util.Date endDate, TimeZoneId timeZoneID, DateRecurrence pattern)
Constructs a recurring Appointment object.

Appointment(java.lang.String sSubject, java.util.Date date, boolean bAllDay, TimeZoneId timeZoneID)
Constructor.

Appointment(java.lang.String sSubject, java.util.Date startDate, java.util.Date endDate, TimeZoneId timeZoneID)
Constructor.

Appointment(java.lang.String sSubject, java.util.Date startDate, java.util.Date endDate, TimeZoneId timezoneId, DateRecurrence pattern)
Constructs a recurring Appointment object.

Appointment(java.lang.String sSubject, DateRange dateRange, DateRecurrence pattern, TimeZoneId timezoneId)
Constructs a recurring Appointment object.

Appointment(java.lang.String sSubject, DateRange dateRange, TimeZoneId timeZoneID)
Constructs an Appointment object.

Method Summary

Meeting	accept() Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverAccept()
Meeting	acceptTentative() Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverAcceptTentative()
java.lang.Object	clone() Creates and returns a copy of this object.
Meeting	decline() Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverDecline()
void	delete(boolean bAllOccurences) Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverDelete(boolean)
java.lang.String	getAppointmentUID() Gets the unique id of this appointment or meeting.
BusyStatus	getBusyStatus() Gets the status of whether the attendee is busy at the time of this appointment on their calendar.
java.util.Date	getCreated() Gets the date and time that the organizer created this appointment or meeting.
DateRange	getDateRange() Gets the start and end date for this appointment.
static java.util.List	getDefaultProperties() Gets a list of default properties pertaining to an appointment/meeting.
java.lang.String	getDescriptionURL() Gets the URL of a resource that contains a description of this appointment or meeting.
int	getDuration() Gets the duration, in seconds, of this appointment.
int	getDurationMintues() Gets the duration, in minutes, of this appointment.
java.util.Date	getEndDate() Gets the date and time when this appointment ends.
double	getGeoLatitude() Gets the geographical latitude of the location of this appointment.
double	getGeoLongitude() Gets the geographical longitude of the location of this appointment.
InstanceType	getInstanceType() Gets the instance type of this appointment.
java.lang.String	getLocation() Gets the location of this appointment.
java.lang.String	getLocationURL() Gets URL where you can access location information in HTML format.
MeetingStatus	getMeetingStatus() Gets the current status of this appointment.
java.util.List	getOptionalAttendees() Gets a list of attendees optional to meet for this appointment
java.lang.String	getOptionalAttendeesString() Gets the string representation of a list of attendees optional to meet for this appointment.
java.lang.String	getOrganizer() Gets the orgainzer (email alais) for this appointment.
Appointment	getParentAppointment() Gets the parent appointment.
Appointment	getParentAppointment(java.util.List properties) Gets the parent appointment.
Priority	getPriority() Gets the priority level for this appointment.
static java.util.List	getProperties() Gets a list of default properties pertaining to an appointment.
java.util.Date	getRecurrenceID() Gets a specific instance of a recurring appointment.
DateRecurrence	getRecurrencePattern() Gets the rule for the pattern that defines a recurring appointment.
int	getReminderOffset() Gets the number of seconds before an appointment starts that a reminder is to be displayed.
int	getReminderOffsetMinutes() Gets the number of minutes before an appointment starts that a reminder is to be displayed.
java.util.Date	getReminderTime() Gets the reminder time for this appointment.
java.util.Date	getReplyTime() Gets the date and time when an attendee replied to a meeting request.
java.util.List	getRequiredAttendees() Gets a list of attendees required to meet for this appointment
java.lang.String	getRequiredAttendeesString() Gets the string representation of a list of attendees required to meet for this appointment.
java.util.List	getResources() Gets a list of resources, such as rooms and video equipment, that are available for an appointment.
java.lang.String	getResourcesString() Gets the string representation of a list of resources, such as rooms and video equipment, that are available for an appointment.
ResponseStatus	getResponseStatus() Gets the response status.
Sensitivity	getSensitivity() Gets the sensitivity level of this appointment.
java.util.Date	getStartDate() Gets the date and time when this appointment starts.
AppointmentStatus	getStatus() Gets the status of this appointment.
java.lang.String	getSubject() Gets the subject of this appointment.
java.lang.String	getSubject(int iLength) Gets the subject of this appointment.
java.lang.String	getTimeZone() Gets the time zone.
TimeZoneId	getTimeZoneID() Gets the time zone identifier.
boolean	isAllDayEvent() Indicates whether this appointment is an all day event.
boolean	isRecurring() Checks if the appointment is recurring.
boolean	isReminderSet() Determines if the reminder is set for this appointment.
boolean	isResponseRequested() Gets if the originator of the meeting requested a response.
boolean	isSpanning() Determine if this appointment/event covers at least 24 hours.
Meeting	respond(ResponseStatus status) Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverRespond(ResponseStatus)
Meeting	respond(ResponseStatus status, Folder folder) Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverRespond(ResponseStatus, Folder)
com.compoze.util.webdav.WebdavResponse30	send() Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverSend()
com.compoze.util.webdav.WebdavResponse30	sendCancellation() Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverSendCancellation()
Meeting	serverAccept() Request the server to accept this appointment and return a meeting response.
Meeting	serverAcceptTentative() Request the server to tentatively accept this appointment and return a meeting response.
Meeting	serverDecline() Request the server to decline this appointment and return a meeting response.
void	serverDelete(boolean bAllOccurences) Requests the server to delete this and all occurrences of this appointment (the appointment is removed permanently)..
FreeBusy[]	serverGetFreeBusy(java.util.List listAttendees) Queries the server for free busy information for each of the specified attendees
FreeBusy[]	serverGetFreeBusy(java.util.List listAttendees, java.util.Date startDate, java.util.Date endDate, int iInterval) Queries the server for free busy information for each of the specified attendees
Appointment	serverGetParentAppointment(java.util.List properties) Queries the server to get the parent appointment (the master instance) of an instance of or exception to a recurrence pattern.
Meeting	serverRespond(ResponseStatus status) Request the server to respond to this appointment and return a meeting response.
Meeting	serverRespond(ResponseStatus status, Folder folder) Request the server to respond to this appointment and return a meeting response.
void	serverSend() Request the server to send a meeting request this appointment.
void	serverSendCancellation() Request the server to send a meeting cancellation this appointment.
void	serverUpdate(boolean bServerRefresh) Requests the server to update the appointment of any changed properties.
void	setAllDayEvent(boolean bAllDayEvent) Sets whether the appointment or meeting is scheduled for an entire day.
void	setAppointmentUID(java.lang.String sUniqueId) Sets the unique identifier of this appointment or meeting.
void	setBccAddresses(java.util.List addresses) Sets the blind carbon copy (Bcc) addresses.
void	setBusyStatus(BusyStatus busyStatus) Sets the status of whether the attendee is busy at the time of this appointment on their calendar.
void	setDateRange(DateRange dateRange) Sets the start and end date for this appointment.
void	setDescriptionURL(java.lang.String sDescriptionURL) Sets the URL of a resource that contains a description of this appointment or meeting.
void	setDescriptionURL(java.net.URL descriptionURL) Sets the URL of a resource that contains a description of this appointment or meeting.
void	setDuration(int iDuration) Sets the duration, in seconds, of this appointment.
void	setDurationMinutes(int iDuration) Sets the duration, in minutes, of this appointment.
void	setEndDate(java.util.Date endDate) Sets the date and time when this appointment ends.
void	setFrom(com.compoze.util.mail.InternetAddress[] addresses) Sets "From" field with internet addresses of whom this message was sent.
void	setFrom(java.lang.String sAddresses) Sets "From" field with sequence of internet addresses of whom this message was sent.
void	setFromAddress(java.lang.String sFromAddress) Sets the address from whom the message was sent.
void	setFromAddresses(java.util.List addresses) Sets the addresses from whom the message was sent.
void	setGeoLatitude(double dGeoLatitude) Sets the geographical latitude of the location of this appointment.
void	setGeoLongitude(double dGeoLongitude) Sets the geographical longitude of the location of this appointment/meeting.
void	setInstanceType(InstanceType type) Sets the instance type of this appointment.
void	setLocation(java.lang.String sLocation) Sets the location of this appointment.
void	setLocationURL(java.lang.String sLocationURL) Sets URL where you can access location information in HTML format
void	setLocationURL(java.net.URL locationURL) Sets URL where you can access location information in HTML format
void	setOptionalAttendees(com.compoze.util.mail.InternetAddress[] attendeeList) Sets internet addresses of attendees optional to meet for this appointment.
void	setOptionalAttendees(java.util.List attendees) Sets a list of attendees optional to meet for this appointment
void	setOptionalAttendees(java.lang.String sAttendeeList) Sets internet addresses of attendees optional to meet for this appointment.
void	setOrganizer(java.lang.String sOrganizer) Sets the orgainzer (email alias) for this appointment.
void	setPriority(Priority priority) Sets the priority level for this appointment.
void	setRecurrencePattern(DateRecurrence pattern) Sets the rule for the pattern that defines a recurring appointment.
void	setReminderOffset(int iSeconds) Gets the number of seconds before an appointment starts that a reminder is to be displayed.
void	setReminderOffsetMinutes(int iMinutes) Sets the number of minutes before an appointment starts that a reminder is to be displayed.
void	setReminderSet(boolean bReminderSet) Sets the reminder as set for this appointment.
void	setReminderTime(java.util.Date reminderTime) Sets the reminder time for this appointment.
void	setRequiredAttendees(com.compoze.util.mail.InternetAddress[] attendeeList) Sets internet addresses of attendees required to meet for this appointment.
void	setRequiredAttendees(java.util.List attendees) Sets a list of attendees required to meet for this appointment
void	setRequiredAttendees(java.lang.String sAttendeeList) Sets internet addresses of attendees required to meet for this appointment.
void	setResources(com.compoze.util.mail.InternetAddress[] resourceList) Sets internet addresses of resources, such as rooms and video equipment, that are available for this appointment.
void	setResources(java.util.List resources) Sets a list of resources, such as rooms and video equipment, that are available for an appointment.
void	setResources(java.lang.String sResourceList) Sets internet addresses of resources, such as rooms and video equipment, that are available for this appointment.
void	setResponseRequested(boolean bReponseRequested) Sets if the originator of the meeting requested a response.
void	setResponseStatus(ResponseStatus status) Sets the response status.
void	setSensitivity(Sensitivity sensitivity) Sets the sensitivity level of this appointment.
void	setStartDate(java.util.Date startDate) Sets the date and time when this appointment starts.
void	setStatus(AppointmentStatus status) Sets the status of this appointment.
void	setSubject(java.lang.String sSubject) Sets the subject of this appointment.
void	setTimeZone(java.lang.String sTimeZone) Sets the time zone.
void	setTimeZoneID(TimeZoneId timeZoneID) Sets the time zone identifier.
java.lang.String	toString() Returns a string representation of the object.

Methods inherited from class com.compoze.exchange.webdav.AbstractMessage

addAttachment, createFilename, equals, getAttachments, getBccAddresses, getBccAddressesString, getBccRecipients, getBody, getCategories, getCcAddresses, getCcAddressesString, getCcRecipients, getContactNames, getDateReceived, getFrom, getFromAddresses, getFromAddressesString, getFromEmailAddress, getFromName, getImportance, getNormalizedSubject, getSize, getTextDescription, getToAddresses, getToAddressesString, getToRecipients, getType, hasAttachment, isRead, serverDeleteAttachment, serverGetAttachments, setBccRecipients, setBccRecipients, setBody, setCategories, setCategories, setCcAddresses, setCcRecipients, setCcRecipients, setContactNames, setContactNames, setDateReceived, setImportance, setRead, setTextDescription, setToAddresses, setToRecipients, setToRecipients, setType

Methods inherited from class com.compoze.exchange.webdav.AbstractItem

copy, copy, copy, createFilename, delete, equals, getComment, getContentClass, getCreationDate, getDateLastModified, getDisplayName, getFile, getHRef, getID, getParentFolder, getPermanentURL, getUID, isFolder, isHidden, isReadOnly, isRoot, move, move, move, serverCopyTo, serverCopyTo, serverCopyTo, serverCopyTo, serverDelete, serverGetParentFolder, serverMoveTo, serverMoveTo, serverMoveTo, serverMoveTo, serverUpdate, setComment, setContentClass, setContentClass, setHidden, setReadOnly, setReleased, setType, setUID, update, update, validate

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Appointment

public Appointment(java.util.Date date,
                   boolean bAllDay,
                   TimeZoneId timeZoneID)

Constructor.

Parameters:

date - the date of this appointment.

bAllDay - true to make thi appointment an all day event; false otherwise.

timeZoneID - the timezone ID (must not be null).

Appointment

public Appointment(java.lang.String sSubject,
                   java.util.Date date,
                   boolean bAllDay,
                   TimeZoneId timeZoneID)

Constructor.

Parameters:

sSubject - the subject of this appointment.

date - the date of this appointment.

bAllDay - true to make this appointment an all day event; false otherwise.

timeZoneID - the timezone ID (must not be null).

Appointment

public Appointment(java.util.Date startDate,
                   java.util.Date endDate,
                   TimeZoneId timeZoneID)

Constructor.

Parameters:

startDate - the start date of this appointment (must not be null).

endDate - the end date of this appointment.

timeZoneID - the timezone ID (must not be null).

Appointment

public Appointment(java.lang.String sSubject,
                   java.util.Date startDate,
                   java.util.Date endDate,
                   TimeZoneId timeZoneID)

Constructor.

Parameters:

sSubject - the subject of this appointment.

startDate - the start date of this appointment (must not be null.

endDate - the end date of this appointment.

timeZoneID - the timezone ID (must not be null).

Appointment

public Appointment(java.util.Date startDate,
                   java.util.Date endDate,
                   TimeZoneId timeZoneID,
                   DateRecurrence pattern)

Constructs a recurring Appointment object.

Parameters:

startDate - the start date of this appointment (must not be null).

endDate - the end date of this appointment.

timeZoneID - the timezone ID (must not be null).

pattern - the date recurrence pattern (must not be null)

Appointment

public Appointment(java.lang.String sSubject,
                   java.util.Date startDate,
                   java.util.Date endDate,
                   TimeZoneId timezoneId,
                   DateRecurrence pattern)

Constructs a recurring Appointment object.

Parameters:

sSubject - the subject of this appointment.

startDate - the start date of this appointment (must not be null).

endDate - the end date of this appointment.

timeZoneID - the timezone ID (must not be null).

pattern - the date recurrence pattern (must not be null)

Appointment

public Appointment(java.lang.String sSubject,
                   DateRange dateRange,
                   TimeZoneId timeZoneID)

Constructs an Appointment object.

Parameters:

sSubject - the subject of the appointment.

dateRange - the start and end time of the appointment (must not be null).

timeZoneID - the timezone ID (must not be null).

Appointment

public Appointment(java.lang.String sSubject,
                   DateRange dateRange,
                   DateRecurrence pattern,
                   TimeZoneId timezoneId)

Constructs a recurring Appointment object.

Parameters:

sSubject - the subject of the appointment or meeting (must not be null or empty)

dateRange - the start and end time of the appointment or meeting (must not be null)

pattern - the date recurrence pattern (must not be null)

timezoneID - the timezone ID (must not be null)

Method Detail

getTimeZone

public java.lang.String getTimeZone()

Gets the time zone.

All time zone definintions are defined as a VTIMEZONE calendar component. For instance, this would be the definiton for Eastern Standard Time as a VTIMEZONE calendar component:

  BEGIN:VTIMEZONE
  TZID:GMT -0500 (Standard) / GMT -0400 (Daylight)
  BEGIN:STANDARD
  DTSTART:19671029T020000
  RRULE:FREQ=YEARLY;BYDAY=-1SU;BYMONTH=10
  TZOFFSETFROM:-0400
  TZOFFSETTO:-0500
  END:STANDARD
  BEGIN:DAYLIGHT
  DTSTART:19670402T020000
  RRULE:FREQ=YEARLY;BYDAY=1SU;BYMONTH=4
  TZOFFSETFROM:-0500
  TZOFFSETTO:-0400
  END:DAYLIGHT
  END:VTIMEZONE
 

For more information pertaining to iCalendar components, see specification RFC 2445 "Internet Calendaring and Scheduling Core Object Specification (iCalendar)".

Returns:

the time zone (may be null)

See Also:

CalendarProperty.TIME_ZONE, getTimeZoneID()

setTimeZone

public void setTimeZone(java.lang.String sTimeZone)

Sets the time zone. Using the method enables one to define time zones not defined in TimeZoneId. If setting a time zone definition, setting a time zone id will be ignored.

All time zone definintions must be defined as a VTIMEZONE calendar component. For instance, this would be the definiton for Eastern Standard Time as a VTIMEZONE calendar component:

  BEGIN:VTIMEZONE
  TZID:GMT -0500 (Standard) / GMT -0400 (Daylight)
  BEGIN:STANDARD
  DTSTART:19671029T020000
  RRULE:FREQ=YEARLY;BYDAY=-1SU;BYMONTH=10
  TZOFFSETFROM:-0400
  TZOFFSETTO:-0500
  END:STANDARD
  BEGIN:DAYLIGHT
  DTSTART:19670402T020000
  RRULE:FREQ=YEARLY;BYDAY=1SU;BYMONTH=4
  TZOFFSETFROM:-0500
  TZOFFSETTO:-0400
  END:DAYLIGHT
  END:VTIMEZONE
 

For more information pertaining to iCalendar components, see specification RFC 2445 "Internet Calendaring and Scheduling Core Object Specification (iCalendar)".

Parameters:

sTimeZone - the time zone as a VTIMEZONE calendar component

See Also:

CalendarProperty.TIME_ZONE, setTimeZoneID(TimeZoneId)

isReminderSet

public boolean isReminderSet()

Determines if the reminder is set for this appointment.

Returns:

true if reminder is set for the appointment.

setReminderSet

public void setReminderSet(boolean bReminderSet)

Sets the reminder as set for this appointment. If reminder is set (true), set either a reminder time (setReminderTime(Date) or a reminder offset (setReminderOffset(long)). If reminder is not set (false), the reminder for this appointment is turned off.

Parameters:

bReminderSet - true if reminder is set for the appointment; false otherwise.

getReminderTime

public java.util.Date getReminderTime()

Gets the reminder time for this appointment.

Returns:

the reminder time for the appointment, or null if not set.

setReminderTime

public void setReminderTime(java.util.Date reminderTime)

Sets the reminder time for this appointment. This method is used in conjunction with setReminderSet(boolean).

Parameters:

reminderTime - the reminder time for the appointment (must not be null).

getReminderOffsetMinutes

public int getReminderOffsetMinutes()

Gets the number of minutes before an appointment starts that a reminder is to be displayed.

Returns:

the reminder in minutes.

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

CalendarProperty.REMINDER_OFFSET

setReminderOffsetMinutes

public void setReminderOffsetMinutes(int iMinutes)

Sets the number of minutes before an appointment starts that a reminder is to be displayed.

Parameters:

iMinutes - the reminder in minutes

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

CalendarProperty.REMINDER_OFFSET

getReminderOffset

public int getReminderOffset()

Gets the number of seconds before an appointment starts that a reminder is to be displayed.

Returns:

the reminder in seconds.

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

CalendarProperty.REMINDER_OFFSET

setReminderOffset

public void setReminderOffset(int iSeconds)

Gets the number of seconds before an appointment starts that a reminder is to be displayed.

Parameters:

iSeconds - the reminder in seconds

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

CalendarProperty.REMINDER_OFFSET

getStatus

public AppointmentStatus getStatus()

Gets the status of this appointment.

Returns:

the appointment status, or null if the appointment status is not set

setStatus

public void setStatus(AppointmentStatus status)

Sets the status of this appointment.

Parameters:

status - the status of the appointment (may not be null)

getResponseStatus

public ResponseStatus getResponseStatus()

Gets the response status.

Returns:

the response status, or null if not set.

See Also:

MapiProperty.APPOINTMENT_RESPONSE_STATUS

setResponseStatus

public void setResponseStatus(ResponseStatus status)

Sets the response status.

Parameters:

status - the response status.

See Also:

MapiProperty.APPOINTMENT_RESPONSE_STATUS

getSubject

public java.lang.String getSubject()

Gets the subject of this appointment.

Overrides:

getSubject in class AbstractMessage

Returns:

the subject of this appointment, or null if not set

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

HttpMailProperty.SUBJECT

getSubject

public java.lang.String getSubject(int iLength)

Gets the subject of this appointment. The subject is truncated after the specified number of characters and "..." is appended to it.

Parameters:

iLength - the maximum length of the result (string plus "...")

Returns:

the truncated subject of the appointment, or null if not set

See Also:

HttpMailProperty.SUBJECT

setSubject

public void setSubject(java.lang.String sSubject)

Sets the subject of this appointment.

Overrides:

setSubject in class AbstractMessage

Parameters:

sSubject - the subject of this appointment

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

HttpMailProperty.SUBJECT

isAllDayEvent

public boolean isAllDayEvent()

Indicates whether this appointment is an all day event.

Returns:

true if appointment is all day, false otherwise. All Day Events run from midnight to midnight over the course of at least 1 day.

isSpanning

public boolean isSpanning()

Determine if this appointment/event covers at least 24 hours.

Returns:

true if appointment spans at least 24 hours, false otherwise

setAllDayEvent

public void setAllDayEvent(boolean bAllDayEvent)

Sets whether the appointment or meeting is scheduled for an entire day. Setting this field does not affect the start time or the end time of the appointment.

Parameters:

bAllDayEvent - true if event is scheduled all day

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

CalendarProperty.ALLDAYEVENT

getBusyStatus

public BusyStatus getBusyStatus()

Gets the status of whether the attendee is busy at the time of this appointment on their calendar.

Returns:

the busy status of the attendee, or null if not set

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

CalendarProperty.BUSY_STATUS

setBusyStatus

public void setBusyStatus(BusyStatus busyStatus)

Sets the status of whether the attendee is busy at the time of this appointment on their calendar.

Parameters:

busyStatus - the busy status of the attendee

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

CalendarProperty.BUSY_STATUS

getCreated

public java.util.Date getCreated()

Gets the date and time that the organizer created this appointment or meeting. The value of this field is the same in the original appointment and in the copy that is sent to each attendee.

Returns:

the date the appointment was created, or null if not set

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

CalendarProperty.CREATED

getDescriptionURL

public java.lang.String getDescriptionURL()

Gets the URL of a resource that contains a description of this appointment or meeting.

Returns:

the url to the description, or null if not set

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

CalendarProperty.DESCRIPTION_URL

setDescriptionURL

public void setDescriptionURL(java.net.URL descriptionURL)

Sets the URL of a resource that contains a description of this appointment or meeting.

Parameters:

descriptionURL - the URL to the description

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

CalendarProperty.DESCRIPTION_URL

setDescriptionURL

public void setDescriptionURL(java.lang.String sDescriptionURL)

Sets the URL of a resource that contains a description of this appointment or meeting.

Parameters:

sDescriptionURL - the URL to the description

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

CalendarProperty.DESCRIPTION_URL

getEndDate

public java.util.Date getEndDate()

Gets the date and time when this appointment ends.

Returns:

the end date of this appointment

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

CalendarProperty.DATE_END

setEndDate

public void setEndDate(java.util.Date endDate)

Sets the date and time when this appointment ends.

Parameters:

endDate - the end date

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

CalendarProperty.DATE_END

getDateRange

public DateRange getDateRange()

Gets the start and end date for this appointment.

Returns:

the date range of this appointment

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

CalendarProperty.DATE_START, CalendarProperty.DATE_END

setDateRange

public void setDateRange(DateRange dateRange)

Sets the start and end date for this appointment.

Parameters:

dateRange - the date range

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

CalendarProperty.DATE_START, CalendarProperty.DATE_END

getStartDate

public java.util.Date getStartDate()

Gets the date and time when this appointment starts.

Returns:

start date of this appointment

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

CalendarProperty.DATE_START

setStartDate

public void setStartDate(java.util.Date startDate)

Sets the date and time when this appointment starts.

Parameters:

startDate - the start date

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

CalendarProperty.DATE_START

getDurationMintues

public int getDurationMintues()

Gets the duration, in minutes, of this appointment.

Returns:

the duration in minutes.

See Also:

CalendarProperty.DURATION

setDurationMinutes

public void setDurationMinutes(int iDuration)

Sets the duration, in minutes, of this appointment.

Parameters:

iDuration - the duration in minutes

See Also:

CalendarProperty.DURATION

getDuration

public int getDuration()

Gets the duration, in seconds, of this appointment.

Returns:

the duration in seconds.

See Also:

CalendarProperty.DURATION

setDuration

public void setDuration(int iDuration)

Sets the duration, in seconds, of this appointment.

Parameters:

iDuration - the duration in seconds

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

CalendarProperty.DURATION

getGeoLatitude

public double getGeoLatitude()

Gets the geographical latitude of the location of this appointment. Positive values from 0 to 90 specify degrees north latitude. Negative values from 0 to -90 specify degrees south latitude.

Returns:

the latitude of the location of this appointment

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

CalendarProperty.GEO_LATITUDE

setGeoLatitude

public void setGeoLatitude(double dGeoLatitude)

Sets the geographical latitude of the location of this appointment. Positive values from 0 to 90 specify degrees north latitude. Negative values from 0 to -90 specify degrees south latitude.

Parameters:

dGeoLatitude - the latitude of the location

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

CalendarProperty.GEO_LATITUDE

getGeoLongitude

public double getGeoLongitude()

Gets the geographical longitude of the location of this appointment. Positive values from 0 to 180 are degrees east longitude. Negative values from 0 to -180 are degrees west longitude.

Returns:

the geolongitude of the location of this appointment

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

CalendarProperty.GEO_LONGITUDE

setGeoLongitude

public void setGeoLongitude(double dGeoLongitude)

Sets the geographical longitude of the location of this appointment/meeting. Positive values from 0 to 180 are degrees east longitude. Negative values from 0 to -180 are degrees west longitude.

Parameters:

dGeoLongitude - the geolongitude of the location

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

CalendarProperty.GEO_LONGITUDE

getInstanceType

public InstanceType getInstanceType()

Gets the instance type of this appointment.

Returns:

the instance type of the appointment.

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

CalendarProperty.INSTANCE_TYPE

setInstanceType

public void setInstanceType(InstanceType type)

Sets the instance type of this appointment.

Parameters:

type - the instance type of the appointment.

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

CalendarProperty.INSTANCE_TYPE

getLocation

public java.lang.String getLocation()

Gets the location of this appointment.

Returns:

the location of this appointment, or null if not set

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

CalendarProperty.LOCATION

setLocation

public void setLocation(java.lang.String sLocation)

Sets the location of this appointment.

Parameters:

sLocation - the location

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

CalendarProperty.LOCATION

getLocationURL

public java.lang.String getLocationURL()

Gets URL where you can access location information in HTML format.

Returns:

the url to access location information, or null if not set

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

CalendarProperty.LOCATION_URL

setLocationURL

public void setLocationURL(java.net.URL locationURL)

Sets URL where you can access location information in HTML format

Parameters:

locationURL - the url to location information

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

CalendarProperty.LOCATION_URL

setLocationURL

public void setLocationURL(java.lang.String sLocationURL)

Sets URL where you can access location information in HTML format

Parameters:

sLocationURL - the url to location information

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

CalendarProperty.LOCATION_URL

getMeetingStatus

public MeetingStatus getMeetingStatus()

Gets the current status of this appointment.

Returns:

the meeting status of this appointment, or null if not set

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

CalendarProperty.MEETING_STATUS

getOrganizer

public java.lang.String getOrganizer()

Gets the orgainzer (email alais) for this appointment.

Returns:

the organizer (email alais) for this appointment, or null if not set

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

CalendarProperty.ORGANIZER

setOrganizer

public void setOrganizer(java.lang.String sOrganizer)

Sets the orgainzer (email alias) for this appointment.

Parameters:

sOrganizer - orgainzer(email address)

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

CalendarProperty.ORGANIZER

getPriority

public Priority getPriority()

Gets the priority level for this appointment.

Returns:

the priority level for this appointment, or null if not set

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

HttpMailProperty.PRIORITY

setPriority

public void setPriority(Priority priority)

Sets the priority level for this appointment.

Parameters:

priority - the priority level

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

HttpMailProperty.PRIORITY

isRecurring

public boolean isRecurring()

Checks if the appointment is recurring.

Returns:

true if the appointment is recurring; false otherwise

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

getRecurrencePattern

public DateRecurrence getRecurrencePattern()

Gets the rule for the pattern that defines a recurring appointment.
A recurrence pattern may only be retrieved if this object represents a master recurring appointment (instance type of InstanceType.MASTER). If this object is an instance(InstanceType.INSTANCE) or exception InstanceType.EXCEPTION of the recurrence pattern, one must call getParentAppointment() and then call getRecurrencePattern() on the returned appointment object.

Returns:

the recurrence pattern or null if the appointment is not recurring

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

getParentAppointment()

setRecurrencePattern

public void setRecurrencePattern(DateRecurrence pattern)

Sets the rule for the pattern that defines a recurring appointment.
A recurrence pattern may only be manipulated if an appointment is either a single appointment (instance type of InstanceType.SINGLE or a master recurring appointment (instance type of InstanceType.MASTER).

Parameters:

pattern - the recurrence pattern

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

UnsupportedOperationException - if trying to set the reccurrence when the appointment is an instance of or exception to the recurrence patthern

getRecurrenceID

public java.util.Date getRecurrenceID()

Gets a specific instance of a recurring appointment. It is used with the sequence Field to uniquely identify the instance. The value of the recurrence identifier is the starting date and time of the specific instance.

Returns:

recurrence id, or null if not set

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

CalendarProperty.RECURRENCE_ID

getReplyTime

public java.util.Date getReplyTime()

Gets the date and time when an attendee replied to a meeting request.

Returns:

the reply time, or null if not set

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

CalendarProperty.REPLY_TIME

isResponseRequested

public boolean isResponseRequested()

Gets if the originator of the meeting requested a response. When attendees are invited to this appointment, by default a request for a response is made

Returns:

true if originator requested a response

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

CalendarProperty.RESPONSE_REQUESTED

setResponseRequested

public void setResponseRequested(boolean bReponseRequested)

Sets if the originator of the meeting requested a response. When attendees are invited to this appointment, by default a request for a response is made

Parameters:

bResponseRequested - true if originator requested a response

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

CalendarProperty.RESPONSE_REQUESTED

getSensitivity

public Sensitivity getSensitivity()

Gets the sensitivity level of this appointment.

Overrides:

getSensitivity in class AbstractMessage

Returns:

the sensitivity level, or null if not set

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

ExchangeProperty.SENSITIVITY

setSensitivity

public void setSensitivity(Sensitivity sensitivity)

Sets the sensitivity level of this appointment.

Overrides:

setSensitivity in class AbstractMessage

Parameters:

sensitivity - the sensitivity level

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

ExchangeProperty.SENSITIVITY

getTimeZoneID

public TimeZoneId getTimeZoneID()

Gets the time zone identifier.

Returns:

the time zone identifier

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

CalendarProperty.TIME_ZONE_ID, getTimeZone()

setTimeZoneID

public void setTimeZoneID(TimeZoneId timeZoneID)

Sets the time zone identifier.

Parameters:

timeZoneID - the time zone identifier

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

CalendarProperty.TIME_ZONE_ID, setTimeZone(String)

getAppointmentUID

public java.lang.String getAppointmentUID()

Gets the unique id of this appointment or meeting.

Returns:

the unique identifier of this appointment or meeting

See Also:

CalendarProperty.APPOINTMENT_UID

setAppointmentUID

public void setAppointmentUID(java.lang.String sUniqueId)

Sets the unique identifier of this appointment or meeting.

Parameters:

sUniqueId - the unique identifier of this appointment or meeting.

See Also:

CalendarProperty.APPOINTMENT_UID

getParentAppointment

public Appointment getParentAppointment()
                                 throws ExchangeException

Gets the parent appointment. This appointment can have a parent appointment only if it this appointment is an occurrence (IntanceType.INSTANCE or IntanceType.EXCEPTION of a recurring appointment.

Returns:

the parent appointment if this appointment is an occurrence of a recurring appointment

Throws:

ExchangeException - if a problem occurred while interacting with the Exchange store

ExchangeRuntimeException - if this object has been released and can no longer be used

java.lang.IllegalArgumentException - if properties are not specified

UnsupportedOperationException - if appointment is a non-recurring appointment or is the master instance of a recurring appointment

getParentAppointment

public Appointment getParentAppointment(java.util.List properties)
                                 throws ExchangeException

Gets the parent appointment. This appointment can have a parent appointment only if it this appointment is an occurrence (IntanceType.INSTANCE or IntanceType.EXCEPTION of a recurring appointment.

Parameters:

properties - list of AbstractProperty objects representing Exchange WebDAV properties to query from the Exchange store (must not be null)

Returns:

the parent appointment if this appointment is an occurrence of a recurring appointment

Throws:

ExchangeException - if a problem occurred while interacting with the Exchange store

ExchangeRuntimeException - if this object has been released and can no longer be used

java.lang.IllegalArgumentException - if properties are not specified

UnsupportedOperationException - if appointment is a non-recurring appointment or is the master instance of a recurring appointment

serverGetParentAppointment

public Appointment serverGetParentAppointment(java.util.List properties)
                                       throws ExchangeException

Queries the server to get the parent appointment (the master instance) of an instance of or exception to a recurrence pattern.

Parameters:

properties - list of AbstractProperty objects representing Exchange WebDAV properties to query from the Exchange store (must not be null)

Returns:

the parent appointment if this appointment is an occurrence of a recurring appointment

Throws:

ExchangeException - if a problem occurred while interacting with the Exchange store

ExchangeRuntimeException - if this object has been released and can no longer be used

java.lang.IllegalArgumentException - if properties are not specified

UnsupportedOperationException - if appointment is a non-recurring appointment or is the master instance of a recurring appointment

getRequiredAttendeesString

public java.lang.String getRequiredAttendeesString()

Gets the string representation of a list of attendees required to meet for this appointment.

Returns:

a string representation of a list of internet addresses of required attendees; or null if not set

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

MailHeaderProperty.TO

getRequiredAttendees

public java.util.List getRequiredAttendees()

Gets a list of attendees required to meet for this appointment

Returns:

list of String objects representing internet addresses of required attendee; or an empty list if not set

See Also:

MailHeaderProperty.TO

setRequiredAttendees

public void setRequiredAttendees(java.util.List attendees)

Sets a list of attendees required to meet for this appointment

Parameters:

attendees - list of String objects representing internet addresses of required attendee

See Also:

MailHeaderProperty.TO

setRequiredAttendees

public void setRequiredAttendees(java.lang.String sAttendeeList)
                          throws com.compoze.util.mail.AddressException

Sets internet addresses of attendees required to meet for this appointment.

Parameters:

sAttendeeList - sequence of internet addresses

Throws:

com.compoze.util.mail.AddressException - if parsing of internet addresses fail

See Also:

MailHeaderProperty.TO

setRequiredAttendees

public void setRequiredAttendees(com.compoze.util.mail.InternetAddress[] attendeeList)

Sets internet addresses of attendees required to meet for this appointment.

Parameters:

attendeeList - array of InternetAddress objects

See Also:

MailHeaderProperty.TO

getOptionalAttendeesString

public java.lang.String getOptionalAttendeesString()

Gets the string representation of a list of attendees optional to meet for this appointment.

Returns:

a string representation of a list of internet addresses of required attendees; or null if not set

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used

See Also:

MailHeaderProperty.CC

getOptionalAttendees

public java.util.List getOptionalAttendees()

Gets a list of attendees optional to meet for this appointment

Returns:

list of String objects representing internet addresses of optional attendee; or an empty list if not set

See Also:

MailHeaderProperty.CC

setOptionalAttendees

public void setOptionalAttendees(java.util.List attendees)

Sets a list of attendees optional to meet for this appointment

Parameters:

attendees - list of String objects representing internet addresses of required attendee

See Also:

MailHeaderProperty.CC

setOptionalAttendees

public void setOptionalAttendees(java.lang.String sAttendeeList)
                          throws com.compoze.util.mail.AddressException

Sets internet addresses of attendees optional to meet for this appointment.

Parameters:

sAttendeeList - sequence of internet addresses

Throws:

com.compoze.util.mail.AddressException - if parsing of internet addresses fail

See Also:

MailHeaderProperty.CC

setOptionalAttendees

public void setOptionalAttendees(com.compoze.util.mail.InternetAddress[] attendeeList)

Sets internet addresses of attendees optional to meet for this appointment.

Parameters:

attendeeList - array of InternetAddress objects

See Also:

MailHeaderProperty.CC

getResourcesString

public java.lang.String getResourcesString()

Gets the string representation of a list of resources, such as rooms and video equipment, that are available for an appointment. The resources are specified by mailto URIs.

Please note, this method does not return the resources of an appointment if those resources have been set using Outlook or OWA. This is bug and has been confirmed by Microsoft.

Returns:

a string representation of a list of internet addresses of resources; or null if not set

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used.

See Also:

MailHeaderProperty.BCC

getResources

public java.util.List getResources()

Gets a list of resources, such as rooms and video equipment, that are available for an appointment. The resources are specified by mailto URIs.

Please note, this method does not return the resources of an appointment if those resources have been set using Outlook or OWA. This is bug and has been confirmed by Microsoft.

Returns:

list of String objects representing internet addresses of resources; or an empty list if not set

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used.

See Also:

MailHeaderProperty.BCC

setResources

public void setResources(java.util.List resources)

Sets a list of resources, such as rooms and video equipment, that are available for an appointment. The resources are specified by mailto URIs.

Parameters:

resources - list of String objects representing internet addresses of resources

Throws:

ExchangeRuntimeException - if this object has been released and can no longer be used.

See Also:

MailHeaderProperty.BCC

setResources

public void setResources(java.lang.String sResourceList)
                  throws com.compoze.util.mail.AddressException

Sets internet addresses of resources, such as rooms and video equipment, that are available for this appointment.

Parameters:

sResourceList - sequence of internet addresses

Throws:

com.compoze.util.mail.AddressException - if parsing of internet addresses fail

See Also:

MailHeaderProperty.BCC

setResources

public void setResources(com.compoze.util.mail.InternetAddress[] resourceList)

Sets internet addresses of resources, such as rooms and video equipment, that are available for this appointment.

Parameters:

resourceList - array of InternetAddress objects

See Also:

MailHeaderProperty.BCC

setFromAddress

public void setFromAddress(java.lang.String sFromAddress)

Description copied from class: AbstractMessage

Sets the address from whom the message was sent.

Overrides:

setFromAddress in class AbstractMessage

Throws:

UnsupportedOperationException - if the setFromAddress operation is not supported by this appointment.

setFromAddresses

public void setFromAddresses(java.util.List addresses)

Description copied from class: AbstractMessage

Sets the addresses from whom the message was sent.

Overrides:

setFromAddresses in class AbstractMessage

Throws:

UnsupportedOperationException - if the setFromAddresses operation is not supported by this appointment.

setFrom

public void setFrom(java.lang.String sAddresses)

Description copied from class: AbstractMessage

Sets "From" field with sequence of internet addresses of whom this message was sent.

Overrides:

setFrom in class AbstractMessage

Throws:

UnsupportedOperationException - if the setFrom operation is not supported by this appointment.

setFrom

public void setFrom(com.compoze.util.mail.InternetAddress[] addresses)

Description copied from class: AbstractMessage

Sets "From" field with internet addresses of whom this message was sent.

Overrides:

setFrom in class AbstractMessage

Throws:

UnsupportedOperationException - if the setFrom operation is not supported by this appointment.

setBccAddresses

public void setBccAddresses(java.util.List addresses)

Description copied from class: AbstractMessage

Sets the blind carbon copy (Bcc) addresses.

Overrides:

setBccAddresses in class AbstractMessage

Throws:

UnsupportedOperationException - if the setBccAddresses operation is not supported by this appointment.

send

public com.compoze.util.webdav.WebdavResponse30 send()
                                              throws ExchangeException

Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverSend()

Sends a meeting request for this appointment. A list of attendees, either required, optional, or resources must be set.

Throws:

ExchangeException - if a problem occurred while interacting with the Exchange store

ExchangeResponseException - if not sent successfully

ExchangeRuntimeException - if this object has been released and can no longer be used

serverSend

public void serverSend()
                throws ExchangeException

Request the server to send a meeting request this appointment. A list of attendees, either required, optional, or resources must be set.

Throws:

ExchangeException - if a problem occurred while interacting with the Exchange store

ExchangeResponseException - if not sent successfully

ExchangeRuntimeException - if this object has been released and can no longer be used

sendCancellation

public com.compoze.util.webdav.WebdavResponse30 sendCancellation()
                                                          throws ExchangeException

Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverSendCancellation()

Sends a meeting cancellation for this appointment. A list of attendees, either required, optional, or resources must be set.

Throws:

ExchangeException - if a problem occurred while interacting with the Exchange store

ExchangeResponseException - if not sent successfully

ExchangeRuntimeException - if this object has been released and can no longer be used

serverSendCancellation

public void serverSendCancellation()
                            throws ExchangeException

Request the server to send a meeting cancellation this appointment. A list of attendees, either required, optional, or resources must be set.

Throws:

ExchangeException - if a problem occurred while interacting with the Exchange store

ExchangeResponseException - if not sent successfully

ExchangeRuntimeException - if this object has been released and can no longer be used

accept

public Meeting accept()
               throws ExchangeException

Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverAccept()

Accepts this appointment and returns a new meeting item suitable for a response to this appointment. It is accepted to the user's default Calendar folder.

Returns:

meeting item suitable for an accept response to the appointment.

Throws:

ExchangeException - if a problem occurred while connecting to or interacting with Exchange Server.

serverAccept

public Meeting serverAccept()
                     throws ExchangeException

Request the server to accept this appointment and return a meeting response. The appointment is accepted to the user's "Calendar" folder.

Returns:

meeting response (accept)

Throws:

ExchangeException - if a problem occurred while interacting with the Exchange store

ExchangeRuntimeException - if this object has been released and can no longer be used

acceptTentative

public Meeting acceptTentative()
                        throws ExchangeException

Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverAcceptTentative()

Accepts this appointment tentatively and returns a new meeting item suitable for a response to this appointment. It is accepted tentatively to the user's default Calendar folder.

Returns:

meeting item suitable for a tentative response to the appointment.

Throws:

ExchangeException - if a problem occurred while connecting to or interacting with Exchange Server.

serverAcceptTentative

public Meeting serverAcceptTentative()
                              throws ExchangeException

Request the server to tentatively accept this appointment and return a meeting response. The appointment is tentatively accepted to the user's "Calendar" folder.

Returns:

meeting response (accept tentative)

Throws:

ExchangeException - if a problem occurred while interacting with the Exchange store

ExchangeRuntimeException - if this object has been released and can no longer be used

decline

public Meeting decline()
                throws ExchangeException

Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverDecline()

Declines this appointment and returns a new meeting item suitable for a response to this appointment. It is removed from the user's default Calendar folder.

Returns:

meeting item suitable for a decline response to the appointment.

Throws:

ExchangeException - if a problem occurred while connecting to or interacting with Exchange Server.

serverDecline

public Meeting serverDecline()
                      throws ExchangeException

Request the server to decline this appointment and return a meeting response. The appointment is removed from the the user's "Calendar" folder.

Returns:

meeting response (decline)

Throws:

ExchangeException - if a problem occurred while interacting with the Exchange store

ExchangeRuntimeException - if this object has been released and can no longer be used

respond

public Meeting respond(ResponseStatus status)
                throws ExchangeException

Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverRespond(ResponseStatus)

Creates a new meeting item suitable for a response to this appointment. Based on the specified response status, this appointment is either accepted to or removed from the user's default Calendar folder.

Parameters:

status - the response status: only ResponseStatus.TENTATIVE, ResponseStatus.ACCEPTED, ResponseStatus.DECLINED.

Returns:

response to the appointment.

Throws:

ExchangeException - if a problem occurred while connecting to or interacting with Exchange Server.

serverRespond

public Meeting serverRespond(ResponseStatus status)
                      throws ExchangeException

Request the server to respond to this appointment and return a meeting response. The appointment is accepted to or removed from the user's "Calendar" folder.

Parameters:

status - the response status: only ResponseStatus.TENTATIVE, ResponseStatus.ACCEPTED, ResponseStatus.DECLINED

Returns:

meeting response

Throws:

ExchangeException - if a problem occurred while interacting with the Exchange store

ExchangeRuntimeException - if this object has been released and can no longer be used

respond

public Meeting respond(ResponseStatus status,
                       Folder folder)
                throws ExchangeException

Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverRespond(ResponseStatus, Folder)

Creates a new meeting item suitable for a response to this appointment.

Parameters:

status - the response status: only ResponseStatus.TENTATIVE, ResponseStatus.ACCEPTED, ResponseStatus.DECLINED.

folder - the folder (Caledendar) to save/remove the appointment. Must not be null.

Returns:

meeting item suitable for a response to the appointment.

Throws:

ExchangeException - if a problem occurred while connecting to or interacting with Exchange Server.

serverRespond

public Meeting serverRespond(ResponseStatus status,
                             Folder folder)
                      throws ExchangeException

Request the server to respond to this appointment and return a meeting response.

Parameters:

status - the response status: only ResponseStatus.TENTATIVE, ResponseStatus.ACCEPTED, ResponseStatus.DECLINED

folder - the folder (Caledendar) to save/remove the appointment (must not be null).

Returns:

meeting response

Throws:

ExchangeException - if a problem occurred while interacting with the Exchange store

ExchangeRuntimeException - if this object has been released and can no longer be used

serverUpdate

public void serverUpdate(boolean bServerRefresh)
                  throws ExchangeException

Requests the server to update the appointment of any changed properties.

If the appointment does not exist in the Exchange store, it is created, else the existing appointment is updated.

An AttachmentException is thrown if any conflicts occur attaching (uploading) files to the appointment. The exception will state what files failed to attach. The appointment is still updated and can be sent, but will exclude the failed attachments.

Overrides:

serverUpdate in class AbstractMessage

Parameters:

bServerRefresh - true requests the server to refresh the properties

Throws:

AttachmentException - if any files failed to attached to this appointment.

ExchangeException - if a problem occurred while connecting to or interaction with Exchange Server

ExchangeRuntimeException - if this object has been released and can no longer be used

delete

public void delete(boolean bAllOccurences)
            throws ExchangeException

Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with serverDelete(boolean)

Deletes this and all occurrences of this appointment (if specified parameter is set true). If this appointment is an instance of a recurring appointment, the master appointment is removed. The expansion agent found within Exchange server will then remove all instances/exceptions of the master appointment when a search (with a specifed date range) is performed.

Parameters:

bAllOccurrences - set true to to remove all occurrences of this appointment

Throws:

ExchangeException - if a problem occurred while connecting to or interaction with Exchange Server

serverDelete

public void serverDelete(boolean bAllOccurences)
                  throws ExchangeException

Requests the server to delete this and all occurrences of this appointment (the appointment is removed permanently)..

If this appointment is an instance of a recurring appointment, the master appointment is removed. The expansion agent found within Exchange server will then remove all instances/exceptions of the master appointment when a search (with a specifed date range) is performed.

Parameters:

bAllOccurrences - set true to to remove all occurrences of this appointment

Throws:

ExchangeException - if a problem occurred while connecting to or interaction with Exchange Server

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Creates and returns a copy of this object.

Overrides:

clone in class AbstractMessage

Returns:

a clone of this instance.

Throws:

java.lang.CloneNotSupportedException - if the object's class does not support the Cloneable interface.

toString

public java.lang.String toString()

Returns a string representation of the object.

Overrides:

toString in class AbstractMessage

Returns:

the string representation of the object.

getDefaultProperties

public static java.util.List getDefaultProperties()

Gets a list of default properties pertaining to an appointment/meeting.
Following is the list of properties returned:

• CalendarProperty.ALLDAYEVENT
• CalendarProperty.BUSY_STATUS
• HttpMailProperty.SUBJECT
• CalendarProperty.DATE_START
• CalendarProperty.DATE_END
• CalendarProperty.DURATION
• CalendarProperty.TIME_ZONE
• CalendarProperty.TIME_ZONE_ID
• CalendarProperty.INSTANCE_TYPE
• CalendarProperty.LOCATION
• CalendarProperty.ORGANIZER
• ExchangeProperty.SENSITIVITY
• CalendarProperty.RECURRENCE_ID
• CalendarProperty.RECURRENCE_RULE
• CalendarProperty.REMINDER_OFFSET
• CalendarProperty.EXCEPTION_DATE
• CalendarProperty.APPOINTMENT_UID
• MapiProperty.APPOINTMENT_APPOINTMENT_STATUS
• MapiProperty.APPOINTMENT_RESPONSE_STATUS

Returns:

list (unmodifiable) of properties.

See Also:

AbstractMessage.getDefaultProperties()

getProperties

public static java.util.List getProperties()

Gets a list of default properties pertaining to an appointment.

Returns:

list (unmodifiable) of properties.

See Also:

AbstractMessage.getProperties()

serverGetFreeBusy

public FreeBusy[] serverGetFreeBusy(java.util.List listAttendees)
                             throws ExchangeException

Queries the server for free busy information for each of the specified attendees

Parameters:

listAttendees - a list of strings representing the email addresses of the attendees

Returns:

an array of FreeBusy information

Throws:

ExchangeException -

serverGetFreeBusy

public FreeBusy[] serverGetFreeBusy(java.util.List listAttendees,
                                    java.util.Date startDate,
                                    java.util.Date endDate,
                                    int iInterval)
                             throws ExchangeException

Queries the server for free busy information for each of the specified attendees

Parameters:

listAttendees - a list of strings representing the email addresses of the attendees

startDate - the date to begin searching on

endDate - the date to stop searching on

iInterval - the time interval to return information for (in minutes)

Returns:

an array of FreeBusy information that is parallel to the users in listAttendees

Throws:

ExchangeException -