com.compoze.collab.groupware
Interface ICalendarContainer
- All Superinterfaces
- IContainer, IGroupwareContainer, IItem, Serializable
- All Known Subinterfaces:
- ICmCalendarContainer
public interface ICalendarContainer
- extends IGroupwareContainer
Container class that holds appointments.
Field Summary |
static ContainerClass |
CLASS
The ContainerClass that represents an
ICalendarContainer . |
Fields inherited from interface com.compoze.collab.IContainer |
CONTAINER_CLASS, HAS_SUBCONTAINERS, HOLDS_ITEMS, HOLDS_SUBCONTAINERS, KEYID_CONTAINER_CLASS, KEYID_HAS_SUBCONTAINERS, KEYID_HOLDS_ITEMS, KEYID_HOLDS_SUBCONTAINERS, KEYID_NAME, KEYID_SUBCONTAINER_COUNT, MINIMUM_CONTAINER_KEYS, NAME, SUBCONTAINER_COUNT |
Methods inherited from interface com.compoze.collab.IContainer |
add, add, add, addSubcontainer, copyTo, getContainerClass, getItemCount, getItemCount, getItems, getItems, getItems, getItems, getItems, getName, getSubcontainer, getSubcontainer, getSubcontainers, getSubcontainers, hasSubcontainer, holdsItems, holdsSubcontainers, isUnder, moveTo, setName |
Methods inherited from interface com.compoze.collab.IItem |
commit, containsKey, containsKey, copyProperties, delete, fetchProperties, getAttribute, getEnum, getID, getInputStream, getItemClass, getOutputStream, getParent, getParent, getParentID, getProperties, getProperties, getProperties, getProperty, getProperty, getProperty, getReader, getRootContainer, getSession, getWriter, isMissing, removeAttribute, removeProperty, setAttribute, setProperties, setProperty, setProperty, setProperty |
CLASS
static final ContainerClass CLASS
- The
ContainerClass
that represents an
ICalendarContainer
.
getAppointments
IAppointment[] getAppointments()
throws CollaborationException
- Gets all of the appointments in the container using the default keys specified
for an
IAppointment
.
- Returns
- the appointments (empty array if there are no appointments, never
null
)
- Throws
CollaborationException
getAppointments
IAppointment[] getAppointments(QueryProfile queryProfile)
throws CollaborationException
- Gets all of the appointments in the container matching the specified
QueryProfile
.
- Parameters
queryProfile
- the query profile to use when getting appointments
- Returns
- the appointmentss (empty array if there are no appointments, never
null
)
- Throws
CollaborationException
getAppointments
IAppointmentList getAppointments(QueryProfile queryProfile,
int iPageSize,
int iPage)
throws CollaborationException
- Gets appointments in the container given a number of appointments per 'page'
and a page number. This method can potentially overwrite the start index
and length value provided in
QueryProfile
.
- Parameters
queryProfile
- the query profile to use when getting appointmentsiPageSize
- the count of appointments that makes a 'page' (<=0 for all)iPage
- the page number to fetch (must be >=1)
- Returns
- the appointments
- Throws
CollaborationException
Copyright © 2006 BEA Systems, Inc. All Rights Reserved