|
Compoze Software, Inc. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.compoze.exchange.AbstractItem
com.compoze.exchange.Message
com.compoze.exchange.Appointment
This class is an Exchange appointment. Appointment instances are obtained
from the Appointments
class. Methods that access properites on the class require that the
properties were loaded beforehand, when the message was initially retrieved.
Any methods in this class that begin with the string server
make a query to the server, and require that the
PropertyKey.MESSAGE_ID
and PropertyKey.MESSAGE_TYPE
properties to be loaded beforehand. Any additional
property requirements are indicated on each individual method.
Field Summary | |
static PropertyKey[] |
ALL_PROPS
Contains an array of all of the properties available on a appointment. |
Fields inherited from class com.compoze.exchange.AbstractItem |
m_props, m_session |
Method Summary | |
java.lang.String |
getBillingInfo()
Gets the billing info of the appointment. |
BusyStatus |
getBusyStatus()
Gets the busy status of the appointment. |
java.lang.String[] |
getContactNames()
Gets the contact names of the appointment. |
int |
getDuration()
Gets the duration property of the appointment. |
java.util.Date |
getEndTime()
Gets the end time of the appointment. |
java.lang.String |
getLocation()
Gets the physical location of the appointment. |
MeetingResponseStatus |
getMeetingResponseStatus()
Gets the meeting response status of the appointment. |
MeetingStatus |
getMeetingStatus()
Gets the overall meeting status of the appointment. |
java.lang.String |
getMileage()
Gets the mileage of the appointment. |
AddressEntryInfo |
getOrganizer()
Gets the organizer that initiated the meeting request for the appointment. |
RecurrencePattern |
getRecurrencePattern()
Gets the recurrence pattern for the appointment, which describes all of the parameters for a recurring event. |
int |
getReminderMinutesBeforeStart()
Gets the number of minutes before an event for the reminder. |
java.util.Date |
getReplyTime()
Gets the reply time of the appointment. |
java.lang.String |
getSeriesID()
Gets the ID of the series (if it is a recurring appointment). |
java.util.Date |
getStartTime()
Gets the start time of the appointment. |
boolean |
isAllDayEvent()
Checks if the appointment is an all day event. |
boolean |
isOrganizer()
Checks if the current user is the organizer of the appointment. |
boolean |
isRecurring()
Gets the recurring property of the appointment. |
boolean |
isReminderSet()
Checks if the appointment reminder is set. |
boolean |
isResponseRequested()
Checks if the appointment requests a response. |
boolean |
isSpanning()
Checks if the appointment spans over the period of at least 1 day. |
void |
serverCancelMeeting(boolean bSeries,
boolean bSend,
boolean bSaveInSent)
Cancels the meeting. |
void |
serverCancelMeeting(boolean bSeries,
boolean bSend,
boolean bSaveInSent,
boolean bDelete)
Deprecated. bDelete must always be true since cancelling a meeting and then not removing it can have unpredictable results. Since version 3.1.25 |
void |
serverDelete(boolean bDeletedItems,
boolean bDeleteSeries)
Hits the server to delete the appointment. |
UnresolvedRecipient[] |
serverResolveRecipients(boolean bRemove,
boolean bSeries)
Hits the server to resolve recipients for the message. |
void |
serverRespond(ResponseStatus status,
PropertyValue[] values,
Recipient[] recipients,
boolean bSeries,
boolean bSaveInSent)
Send a response to a meeting that is already established. |
void |
serverUpdate(Recipient[] recipients,
boolean bSeries,
boolean bSend,
boolean bSaveInSent)
Hits the server to update any changed properties. |
void |
setAllDayEvent(boolean bAllDayEvent)
Sets the all day event property of the appointment. |
void |
setBillingInfo(java.lang.String sBillingInfo)
Sets the billing info of the appointment. |
void |
setBusyStatus(BusyStatus status)
Sets the busy status of the appointment. |
void |
setContactNames(java.lang.String[] contactNames)
Sets the contact names of the appointment. |
void |
setDates(java.util.Date startDate,
java.util.Date endDate)
Sets the start and end time of the appointment. |
void |
setLocation(java.lang.String sLocation)
Sets the physical location of the appointment. |
void |
setMeetingResponseStatus(MeetingResponseStatus status)
Sets the meeting response status of the appointment. |
void |
setMeetingStatus(MeetingStatus status)
Sets the overall meeting status of the appointment. |
void |
setMileage(java.lang.String sMileage)
Sets the mileage of the appointment. |
void |
setRecurrencePattern(RecurrencePattern pattern)
Sets the recurrence pattern for the appointment, which describes all of the parameters for a recurring event. |
void |
setReminderMinutesBeforeStart(int iReminderMinutes)
Sets the number of minutes before an event for the reminder. |
void |
setReminderSet(boolean bReminderSet)
Sets the reminder set property of the appointment. |
void |
setReplyTime(java.util.Date replyTime)
Sets the reply time of the appointment. |
void |
setResponseRequested(boolean bResponseRequested)
Sets the response requested property of the appointment. |
void |
setSender(AddressEntry addressEntry)
Sets the sender. |
static Appointment[] |
subList(Appointment[] apts,
java.util.Date givenDate,
java.util.Calendar cal)
Returns an array of appointments from the specified list occuring on the given date. |
static Appointment[] |
subList(Appointment[] apts,
java.util.Date startDate,
java.util.Date endDate,
java.util.Calendar cal)
Returns an array of appointments from the specified list occuring within the given start and end dates. |
Methods inherited from class com.compoze.exchange.AbstractItem |
get, getBoolean, getByteArray, getDate, getDouble, getInt, getInvalidPropertyValues, getPropertyKeys, getString, getStringArray, getUpdatedPropertyValues, set, setBoolean, setByteArray, setDate, setDouble, setInt, setString, setStringArray |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final PropertyKey[] ALL_PROPS
Method Detail |
public BusyStatus getBusyStatus() throws ExchangeException
ExchangeException
PropertyKey.APPOINTMENT_BUSY_STATUS
public void setBusyStatus(BusyStatus status) throws ExchangeException
status
- the busy status of the appointment
ExchangeException
PropertyKey.APPOINTMENT_BUSY_STATUS
public java.lang.String getBillingInfo() throws ExchangeException
ExchangeException
PropertyKey.BILLING_INFO
public void setBillingInfo(java.lang.String sBillingInfo) throws ExchangeException
sBillingInfo
- the billing info of the appointment
ExchangeException
PropertyKey.BILLING_INFO
public java.lang.String getMileage() throws ExchangeException
ExchangeException
PropertyKey.MILEAGE
public void setMileage(java.lang.String sMileage) throws ExchangeException
ExchangeException
PropertyKey.MILEAGE
public java.lang.String[] getContactNames() throws ExchangeException
ExchangeException
PropertyKey.CONTACT_NAMES
public void setContactNames(java.lang.String[] contactNames) throws ExchangeException
contactNames
- the contact names of the appointment
ExchangeException
PropertyKey.CONTACT_NAMES
public java.util.Date getStartTime() throws ExchangeException
ExchangeException
PropertyKey.APPOINTMENT_START_TIME
public void setDates(java.util.Date startDate, java.util.Date endDate) throws ExchangeException
startDate
- the start time of the appointmentendDate
- the end time of the appointment
ExchangeException
PropertyKey.APPOINTMENT_END_TIME
public boolean isAllDayEvent() throws ExchangeException
true
if the appointment is an all day event
ExchangeException
PropertyKey.APPOINTMENT_ALL_DAY_EVENT
public boolean isSpanning() throws ExchangeException
true
if the appointment is longer than 24 hours
ExchangeException
PropertyKey.APPOINTMENT_IS_SPANNING
public boolean isOrganizer() throws ExchangeException
true
if the user is the organizer of the appointment
ExchangeException
PropertyKey.APPOINTMENT_IS_ORGANIZER
public void setAllDayEvent(boolean bAllDayEvent) throws ExchangeException
true
, the appointment dates are
eventually modified to be on 24 hour boundaries from midnight to midnight.
bAllDayEvent
- the all day event property of the appointment
ExchangeException
PropertyKey.APPOINTMENT_ALL_DAY_EVENT
public int getDuration() throws ExchangeException
ExchangeException
PropertyKey.APPOINTMENT_DURATION
public java.util.Date getEndTime() throws ExchangeException
ExchangeException
PropertyKey.APPOINTMENT_END_TIME
public boolean isRecurring() throws ExchangeException
true
if the appointment is recurring
ExchangeException
PropertyKey.APPOINTMENT_IS_RECURRING
public java.lang.String getLocation() throws ExchangeException
ExchangeException
PropertyKey.APPOINTMENT_LOCATION
public java.lang.String getSeriesID() throws ExchangeException
ExchangeException
PropertyKey.APPOINTMENT_SERIES_ID
public void setLocation(java.lang.String sLocation) throws ExchangeException
sLocation
- the location of the appointment
ExchangeException
PropertyKey.APPOINTMENT_LOCATION
public MeetingResponseStatus getMeetingResponseStatus() throws ExchangeException
ExchangeException
PropertyKey.APPOINTMENT_MEETING_RESPONSE_STATUS
public void setMeetingResponseStatus(MeetingResponseStatus status) throws ExchangeException
status
- the meeting response status of the appointment
ExchangeException
PropertyKey.APPOINTMENT_MEETING_RESPONSE_STATUS
public MeetingStatus getMeetingStatus() throws ExchangeException
ExchangeException
PropertyKey.APPOINTMENT_MEETING_STATUS
public void setMeetingStatus(MeetingStatus status) throws ExchangeException
status
- the meeting status of the appointment
ExchangeException
PropertyKey.APPOINTMENT_MEETING_STATUS
public AddressEntryInfo getOrganizer() throws ExchangeException
null
if the appointment has
no organizer
ExchangeException
PropertyKey.APPOINTMENT_ORGANIZER
public void setSender(AddressEntry addressEntry) throws ExchangeException
setSender
in class Message
addressEntry
- the address entry of the sender
ExchangeException
- the address entry id must be availablepublic int getReminderMinutesBeforeStart() throws ExchangeException
ExchangeException
PropertyKey.APPOINTMENT_REMINDER_MINUTES_BEFORE_START
public void setReminderMinutesBeforeStart(int iReminderMinutes) throws ExchangeException
iReminderMinutes
- the number of minutes before an event for
the reminder
ExchangeException
PropertyKey.APPOINTMENT_REMINDER_MINUTES_BEFORE_START
public boolean isReminderSet() throws ExchangeException
true
if a reminder is set for the appointment
ExchangeException
PropertyKey.APPOINTMENT_REMINDER_SET
public void setReminderSet(boolean bReminderSet) throws ExchangeException
ExchangeException
PropertyKey.APPOINTMENT_REMINDER_SET
public java.util.Date getReplyTime() throws ExchangeException
ExchangeException
PropertyKey.APPOINTMENT_REPLY_TIME
public void setReplyTime(java.util.Date replyTime) throws ExchangeException
replyTime
- the reply time of the appointment
ExchangeException
PropertyKey.APPOINTMENT_REPLY_TIME
public boolean isResponseRequested() throws ExchangeException
true
if a response is requested for meeting
requests created for the appointment
ExchangeException
PropertyKey.APPOINTMENT_RESPONSE_REQUESTED
public void setResponseRequested(boolean bResponseRequested) throws ExchangeException
bResponseRequested
- true
if a response is
requested for meeting requests for the appointment
ExchangeException
PropertyKey.APPOINTMENT_RESPONSE_REQUESTED
public static Appointment[] subList(Appointment[] apts, java.util.Date givenDate, java.util.Calendar cal) throws ExchangeException
apts
- the array of appointmentsgivenDate
- the given datecal
- the calendar
ExchangeException
PropertyKey.APPOINTMENT_ALL_DAY_EVENT
,
PropertyKey.APPOINTMENT_END_TIME
,
PropertyKey.APPOINTMENT_START_TIME
public static Appointment[] subList(Appointment[] apts, java.util.Date startDate, java.util.Date endDate, java.util.Calendar cal) throws ExchangeException
apts
- the array of appointmentsstartDate
- the start date (inclusive)endDate
- the end date (inclusive)cal
- the calendar
ExchangeException
PropertyKey.APPOINTMENT_ALL_DAY_EVENT
,
PropertyKey.APPOINTMENT_END_TIME
,
PropertyKey.APPOINTMENT_START_TIME
public RecurrencePattern getRecurrencePattern() throws ExchangeException
ExchangeException
PropertyKey.APPOINTMENT_RECURRENCE_PATTERN
public void setRecurrencePattern(RecurrencePattern pattern) throws ExchangeException
NOTE:
This method only
sets the recurrence pattern to be updated on the server. It does not
affect the result of a call to getRecurrencePattern
until
the appointment has been retrieved from the server. NOTE:
Setting the recurrence pattern on an existing series will cause all exceptions
to that series to be lost.
pattern
- the recurrence pattern
ExchangeException
PropertyKey.APPOINTMENT_RECURRENCE_PATTERN
public void serverDelete(boolean bDeletedItems, boolean bDeleteSeries) throws ExchangeException
bDeletedItems
- if true
, move the appointment
into deleted itemsbDeleteSeries
- if true
and the appointment
is recurring, delete all instances of the recurring appointment
ExchangeException
public void serverUpdate(Recipient[] recipients, boolean bSeries, boolean bSend, boolean bSaveInSent) throws ExchangeException
recipients
- the recipients to add to the message (or
null
for no recipients to add)bSeries
- if true
, update the series rather
then the instance (recurrence pattern may not be changed on
the instance)bSend
- if true
, send the messagebSaveInSent
- if true
and sending the message,
save the message in the Sent Items
folder
ExchangeException
public UnresolvedRecipient[] serverResolveRecipients(boolean bRemove, boolean bSeries) throws ExchangeException
bRemove
- if true
, remove recipients if
they do not resolve.bSeries
- if true
, use the series
Recipient
objects of unresolved
recipients, or an array of zero length if all recipients were
resolved
ExchangeException
public void serverRespond(ResponseStatus status, PropertyValue[] values, Recipient[] recipients, boolean bSeries, boolean bSaveInSent) throws ExchangeException
bSeries
- apply change to the seriesbSaveInSent
- save a copy in the sent items folder
ExchangeException
public void serverCancelMeeting(boolean bSeries, boolean bSend, boolean bSaveInSent) throws ExchangeException
bSeries
- true
to cancel the seriesbSend
- true
to send a cancellation noticebSaveInSent
- true
to save to 'Sent Items'
ExchangeException
- if there is a problem interacting with
Exchange or the Appointment MeetingStatus is not
MeetingStatus.MEETING
public void serverCancelMeeting(boolean bSeries, boolean bSend, boolean bSaveInSent, boolean bDelete) throws ExchangeException
bSeries
- true
to cancel the seriesbSend
- true
to send a cancellation noticebSaveInSent
- true
to save to 'Sent Items'bDelete
- true
to delete the appointment; this
will occur after sending cancellations (if specified)
ExchangeException
- if there is a problem interacting with
Exchange or the Appointment MeetingStatus is not
MeetingStatus.MEETING
|
Compoze Software, Inc. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |