|
Compoze Software, Inc. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.compoze.domino.AbstractItem | +--com.compoze.domino.AbstractDocument | +--com.compoze.domino.Memo | +--com.compoze.domino.Appointment
This class is a Domino appointment. Appointment instances are obtained
from the Documents
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.DOCUMENT_ID
and PropertyKey.DOCUMENT_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 an appointment. |
Fields inherited from class com.compoze.domino.AbstractItem |
m_props, m_session |
Method Summary | |
AppointmentType |
getAppointmentType()
Gets the appointment type of the appointment. |
NameInfo |
getChair()
Gets the chair for the appointment. |
java.util.Date |
getEndDateTime()
Gets the end date time for this appointment. |
java.lang.String |
getEndDateTimeString(java.text.DateFormat dateFormat)
Gets the end date time for this appointment formatted with the specified date format. |
InstanceType |
getInstanceType()
Gets the instance type for this appointment. |
java.lang.String |
getLocation()
Gets the location of the appointment. |
boolean |
getPreventCounter()
Gets the prevent counter propose flag. |
boolean |
getPreventDelegate()
Gets the prevent delegate flag. |
NameInfo |
getPrincipal()
Gets the principal for the appointment. |
java.util.Date |
getStartDateTime()
Gets the start date time for this appointment. |
java.lang.String |
getStartDateTimeString(java.text.DateFormat dateFormat)
Gets the start date time for this appointment formatted with the specified date format. |
boolean |
isAllDayEvent()
Checks if the appointment is an all day event. |
boolean |
isAnniversary()
Checks if the appointment is an anniversary. |
boolean |
isBookFreeTime()
Checks the book free time for the appointment. |
boolean |
isChair()
Checks if this user is the chair. |
boolean |
isChair(UserInfo userInfo)
Checks if the specified user is the chair. |
boolean |
isMarkPrivate()
Checks the mark private flag for the appointment. |
boolean |
isRepeating()
Checks if this appointment is repeating. |
void |
serverCancel(java.lang.String sComment)
Hits the server to cancel the appointment and alert any participants by sending a cancellation notice. |
void |
serverConfirm(java.lang.String sComment)
Hits the server to confirm the appointment and alert any participants by sending a confirmation notice. |
void |
serverDelete()
Hits the server to delete the appointment. |
void |
serverDelete(int iUpdateRule)
Hits the server to delete the appointment. |
InstanceInfo[] |
serverGetInstanceInfoArray()
Hits the server and gets an array of instance info for this appointment. |
RepeatPattern |
serverGetRepeatPattern()
Hits the server and gets the repeat pattern for this appointment. |
MeetingResponse[] |
serverGetResponses()
Hits the server to get the responses to this appointment. |
void |
serverSetRepeatPattern(RepeatPattern pattern)
Hits the server and sets the repeat pattern on the appointment. |
void |
serverUpdate()
Hits the server to update any changed properties. |
void |
serverUpdate(int iUpdateRule)
Hits the server to update any changed properties. |
void |
serverUpdate(int iUpdateRule,
boolean bSend)
Hits the server to update any changed properties. |
void |
serverUpdate(Recipient[] recipients,
boolean bSaveInSent)
Hits the server to send the appointment to the specified recipients. |
void |
setBookFreeTime(boolean bFlag)
Sets the book free time flag of the appointment. |
void |
setDateTimes(java.util.Date startDate,
java.util.Date endDate)
Sets the start and end date time for this appointment. |
void |
setLocation(java.lang.String sLocation)
Sets the location of the appointment. |
void |
setMarkPrivate(boolean bFlag)
Sets the mark private flag of the appointment. |
void |
setPreventCounter(boolean bFlag)
Sets the prevent counter propose flag. |
void |
setPreventDelegate(boolean bFlag)
Sets the prevent delegate flag. |
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.domino.AbstractDocument |
getAttachmentCount, getAttachmentInfo, getAttachmentInfoArray, getDateCreated, getDateCreatedString, getDateModified, getDateModifiedString, getDocumentType, getEmbeddedImageCount, getEmbeddedImageInfo, getEmbeddedImageInfoArray, getID, getParentID, getSize, getSizeInKilos, hasAttachment, serverAddAttachment, serverCopyTo, serverDeleteAttachment, serverMoveTo |
Methods inherited from class com.compoze.domino.AbstractItem |
get, getBoolean, getDate, getDateArray, getDouble, getInt, getPropertyKeys, getString, getStringArray, getUpdatedPropertyValues, set, setBoolean, setDate, setDouble, setInt, setString, setStringArray |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final PropertyKey[] ALL_PROPS
Method Detail |
public boolean isBookFreeTime() throws DominoException
true
for not penciled in; false
for penciled in (time will appear free to others)PropertyKey.BOOK_FREE_TIME
public void setBookFreeTime(boolean bFlag) throws DominoException
bFlag
- true
for pencil in; false
otherwisePropertyKey.BOOK_FREE_TIME
public boolean isMarkPrivate() throws DominoException
true
for marked private; false
otherwisePropertyKey.MARK_PRIVATE
public void setMarkPrivate(boolean bFlag) throws DominoException
bFlag
- true
to mark private; false
otherwisePropertyKey.MARK_PRIVATE
public AppointmentType getAppointmentType() throws DominoException
PropertyKey.APPOINTMENT_TYPE
public void setDateTimes(java.util.Date startDate, java.util.Date endDate) throws DominoException
Note: the start date must be before the end date. If not, the dates are swapped.
startDate
- the start date time (may not be null
)endDate
- the end date time (may not be null
)PropertyKey.START_DATE_TIME
,
PropertyKey.END_DATE_TIME
public boolean isAllDayEvent() throws DominoException
true
if an all day event; false
otherwisePropertyKey.APPOINTMENT_TYPE
,
getAppointmentType()
public boolean isAnniversary() throws DominoException
true
if an anniversary; false
otherwisePropertyKey.APPOINTMENT_TYPE
,
getAppointmentType()
public java.lang.String getLocation() throws DominoException
PropertyKey.LOCATION
public void setLocation(java.lang.String sLocation) throws DominoException
sLocation
- the locationPropertyKey.LOCATION
public boolean isRepeating() throws DominoException
true
if the appointment is repeating; false
otherwisePropertyKey.REPEATS
public NameInfo getChair() throws DominoException
PropertyKey.CHAIR
public NameInfo getPrincipal() throws DominoException
PropertyKey.PRINCIPAL
public boolean isChair() throws DominoException
true
if the user is the chair; false
otherwisePropertyKey.CHAIR
public boolean isChair(UserInfo userInfo) throws DominoException
userInfo
- the user to checktrue
if the user is the chair; false
otherwisePropertyKey.CHAIR
public java.util.Date getStartDateTime() throws DominoException
PropertyKey.START_DATE_TIME
public java.lang.String getStartDateTimeString(java.text.DateFormat dateFormat) throws DominoException
dateFormat
- the date format (may not be null
)null
PropertyKey.START_DATE_TIME
public java.util.Date getEndDateTime() throws DominoException
PropertyKey.END_DATE_TIME
public java.lang.String getEndDateTimeString(java.text.DateFormat dateFormat) throws DominoException
dateFormat
- the date format (may not be null
)null
PropertyKey.END_DATE_TIME
public static Appointment[] subList(Appointment[] apts, java.util.Date givenDate, java.util.Calendar cal) throws DominoException
apts
- the array of appointmentsgivenDate
- the given datecal
- the calendarPropertyKey.END_DATE_TIME
,
PropertyKey.START_DATE_TIME
public static Appointment[] subList(Appointment[] apts, java.util.Date startDate, java.util.Date endDate, java.util.Calendar cal) throws DominoException
apts
- the array of appointmentsstartDate
- the start date (inclusive)endDate
- the end date (inclusive)cal
- the calendarPropertyKey.END_DATE_TIME
,
PropertyKey.START_DATE_TIME
public InstanceType getInstanceType() throws DominoException
PropertyKey.INSTANCE_TYPE
public RepeatPattern serverGetRepeatPattern() throws DominoException
null
if this is not a repeating appointmentisRepeating()
,
PropertyKey.REPEATS
public InstanceInfo[] serverGetInstanceInfoArray() throws DominoException
getInstanceType()
,
InstanceType.PARENT
,
PropertyKey.PARENT_DOCUMENT_ID
public void serverSetRepeatPattern(RepeatPattern pattern) throws DominoException
SINGLE
; otherwise, this method does nothing.
Note: the repeat pattern is set immediately and cannot be undone.
There is no need to call serverUpdate()
.
Note: the existing task start date will be set to the start date of the specified repeat pattern
Note: the start and end date time properties must be loaded prior to calling this method
pattern
- the repeat patten (may not be null
)getInstanceType()
,
PropertyKey.APPOINTMENT_TYPE
,
PropertyKey.INSTANCE_TYPE
,
PropertyKey.START_DATE_TIME
,
PropertyKey.END_DATE_TIME
public void serverDelete() throws DominoException
public void serverDelete(int iUpdateRule) throws DominoException
iUpdateRule
- the update rule (see RepeatPattern.UPDATE_
constants)PropertyKey.REPEATS
,
PropertyKey.START_DATE_TIME
,
PropertyKey.END_DATE_TIME
public void serverCancel(java.lang.String sComment) throws DominoException
Note: this appointment must be of type AppointmentType.MEETING
and
you must be the chair to cancel this appointment. An
AppointmentCancellationException
is thrown if you
are not the chair or this is not an appointment type meeting.
sComment
- the comment or null
for nonePropertyKey.CHAIR
,
PropertyKey.APPOINTMENT_TYPE
,
PropertyKey.SUBJECT
,
isChair()
,
getAppointmentType()
,
AppointmentCancellationException
public MeetingResponse[] serverGetResponses() throws DominoException
Note: this appointment must be of type AppointmentType.MEETING
and
you must be the chair to cancel this appointment.
A DominoException
is thrown if you
are not the chair or this is not an appointment type meeting.
PropertyKey.CHAIR
,
PropertyKey.APPOINTMENT_TYPE
,
isChair()
,
getAppointmentType()
public void serverConfirm(java.lang.String sComment) throws DominoException
Note: this appointment must be of type AppointmentType.MEETING
and
you must be the chair to confirm this appointment. An
AppointmentConfirmationException
is thrown if you
are not the chair or this is not an appointment type meeting.
sComment
- the comment or null
for nonePropertyKey.CHAIR
,
PropertyKey.APPOINTMENT_TYPE
,
PropertyKey.SUBJECT
,
isChair()
,
getAppointmentType()
,
AppointmentConfirmationException
public void serverUpdate() throws DominoException
serverUpdate
in class Memo
public void serverUpdate(int iUpdateRule) throws DominoException
iUpdateRule
- the update rule (see RepeatPattern.UPDATE_
constants)PropertyKey.REPEATS
,
PropertyKey.START_DATE_TIME
,
PropertyKey.END_DATE_TIME
public void serverUpdate(int iUpdateRule, boolean bSend) throws DominoException
iUpdateRule
- the update rule (see RepeatPattern.UPDATE_
constants)bSend
- true
to send an update to existing attendeesPropertyKey.REPEATS
,
PropertyKey.START_DATE_TIME
,
PropertyKey.END_DATE_TIME
public void serverUpdate(Recipient[] recipients, boolean bSaveInSent) throws DominoException
Note: If an attempt is made to include a recipient that is the chair of this appointment,
a ChairNotPermittedException
is thrown.
Note: this method does not update the appointment for modified
properties. Use one of the other serverUpdate()
methods.
serverUpdate
in class Memo
recipients
- the recipients to send the appointment to (may not be null
)bSaveInSent
- true
to save a copy of this in the sent folder; false
otherwiseserverUpdate()
,
serverUpdate(int)
,
PropertyKey.SUBJECT
,
ChairNotPermittedException
public boolean getPreventCounter() throws DominoException
true
to prevent counter propose; false
otherwisePropertyKey.PREVENT_COUNTER
public void setPreventCounter(boolean bFlag) throws DominoException
bFlag
- true
to prevent counter propose; false
otherwisePropertyKey.PREVENT_COUNTER
public boolean getPreventDelegate() throws DominoException
true
to prevent delegating; false
otherwisePropertyKey.PREVENT_DELEGATE
public void setPreventDelegate(boolean bFlag) throws DominoException
bFlag
- true
to prevent delegating; false
otherwisePropertyKey.PREVENT_DELEGATE
|
Compoze Software, Inc. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |