|
Copyright © 2006 BEA Systems, Inc. All Rights Reserved | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ICalendarItem
Calendar items represent the common set of properties and logic among appointments of different types.
Field Summary | |
---|---|
static Key |
BUSY_STATUS
The key representing the busy status of the appointment. |
static Key |
DURATION
The key representing the duration of the appointment (read-only). |
static Key |
END_TIME
The key representing the end time of the appointment. |
static Key |
IS_ALL_DAY
The key that represents if the appointment is an all day event (read-only). |
static Key |
IS_RECURRING
The key that represents if the appointment is recurring (read-only). |
static int |
KEYID_BUSY_STATUS
The int ID for the BUSY_STATUS key. |
static int |
KEYID_DURATION
The int ID for the DURATION key. |
static int |
KEYID_END_TIME
The int ID for the END_TIME key. |
static int |
KEYID_IS_ALL_DAY
The int ID for the IS_ALL_DAY key. |
static int |
KEYID_IS_RECURRING
The int ID for the IS_RECURRING key. |
static int |
KEYID_LOCATION
The int ID for the LOCATION key. |
static int |
KEYID_START_TIME
The int ID for the START_TIME key. |
static Key |
LOCATION
The key representing the location of the appointment. |
static Key |
START_TIME
The key representing the start time of the appointment. |
Fields inherited from interface com.compoze.collab.groupware.IGroupwareItem |
---|
CATEGORIES, DATE_CREATED, DATE_LAST_MODIFIED, IMPORTANCE, KEYID_CATEGORIES, KEYID_DATE_CREATED, KEYID_DATE_LAST_MODIFIED, KEYID_IMPORTANCE, KEYID_SIZE, KEYID_SUBJECT, SIZE, SUBJECT |
Fields inherited from interface com.compoze.collab.messaging.IMessagingItem |
---|
BODY, BODY_HTML, KEYID_BODY, KEYID_BODY_HTML |
Fields inherited from interface com.compoze.collab.IItem |
---|
CLASS, ID, ITEM_CLASS, KEYID_ID, KEYID_ITEM_CLASS, KEYID_PARENT_ID, MINIMUM_ITEM_KEYS, PARENT_ID |
Method Summary | |
---|---|
BusyStatus |
getBusyStatus()
Gets the busy status of this calendar item. |
int |
getDuration()
Gets the duration of the appointment, in minutes. |
Date |
getEndTime()
Gets the end date and time of the appointment. |
String |
getLocation()
Gets the location of the appointment. |
Date |
getStartTime()
Gets the start date and time of the appointment. |
boolean |
isAllDayEvent()
Returns if the appointment is an all day event. |
boolean |
isRecurring()
Returns if the appointment is recurring. |
Methods inherited from interface com.compoze.collab.groupware.IGroupwareItem |
---|
getBodyHtml, getBodyHtml, getCategories, getDateCreated, getDateLastModified, getImportance, getNormalizedSubject, getSize, getSubject, getSubject, getSubjectPrefix, setBodyHtml, setCategories, setImportance, setSubject |
Methods inherited from interface com.compoze.collab.messaging.IMessagingItem |
---|
getBody, setBody |
Methods inherited from interface com.compoze.collab.IItem |
---|
commit, containsKey, containsKey, copyProperties, copyTo, delete, fetchProperties, getAttribute, getEnum, getID, getInputStream, getItemClass, getOutputStream, getParent, getParent, getParentID, getProperties, getProperties, getProperties, getProperty, getProperty, getProperty, getReader, getRootContainer, getSession, getWriter, isMissing, moveTo, removeAttribute, removeProperty, setAttribute, setProperties, setProperty, setProperty, setProperty |
Field Detail |
---|
static final int KEYID_DURATION
int
ID for the DURATION
key.
static final int KEYID_END_TIME
int
ID for the END_TIME
key.
static final int KEYID_START_TIME
int
ID for the START_TIME
key.
static final int KEYID_IS_ALL_DAY
int
ID for the IS_ALL_DAY
key.
static final int KEYID_IS_RECURRING
int
ID for the IS_RECURRING
key.
static final int KEYID_LOCATION
int
ID for the LOCATION
key.
static final int KEYID_BUSY_STATUS
int
ID for the BUSY_STATUS
key.
static final Key DURATION
static final Key START_TIME
static final Key END_TIME
static final Key IS_ALL_DAY
static final Key IS_RECURRING
static final Key LOCATION
static final Key BUSY_STATUS
Method Detail |
---|
int getDuration() throws CollaborationException
CollaborationException
- if there was an error getting the durationDate getStartTime() throws CollaborationException
CollaborationException
- if there was an error getting the start time.Date getEndTime() throws CollaborationException
CollaborationException
- if there was an error fetching the end timeString getLocation() throws CollaborationException
CollaborationException
- if there was an error getting the location.IAppointment.setLocation(String)
boolean isAllDayEvent() throws CollaborationException
true
if the appointment is an all day event.
CollaborationException
- if there was an error getting the all day event flagboolean isRecurring() throws CollaborationException
true
if the appointment is recurring.
CollaborationException
- if there was an error getting the recurring flagBusyStatus getBusyStatus() throws CollaborationException
CollaborationException
- if there was a problem retrieveing
the busy status of this calendar item.BUSY_STATUS
|
Copyright © 2006 BEA Systems, Inc. All Rights Reserved | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |