com.compoze.collab.groupware
Interface IGroupwareContainer

All Superinterfaces:

IContainer, IItem, java.io.Serializable

All Known Subinterfaces:

ICalendarContainer, IContactsContainer, IExchangeCalendarContainer, IExchangeContactsContainer, IExchangeMailContainer, IExchangeTasksContainer, IMailContainer, ITasksContainer, IWebdavCalendarContainer

public interface IGroupwareContainer

extends IContainer

This container is used to indicate a groupware container. The container class is container.groupware.

Field Summary

static ContainerClass	CLASS The container class for an IGroupwareContainer.
static int	KEYID_TOTAL_ITEM_COUNT The int ID for the TOTAL_ITEM_COUNT key.
static int	KEYID_UNREAD_ITEM_COUNT The int ID for the UNREAD_ITEM_COUNT key.
static Key	TOTAL_ITEM_COUNT The key representing the total number of items in a container.
static Key	UNREAD_ITEM_COUNT The key representing the total number of unread, visible items in a container.

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

Fields inherited from interface com.compoze.collab.IItem

ID, ITEM_CLASS, KEYID_ID, KEYID_ITEM_CLASS, KEYID_PARENT_ID, MINIMUM_ITEM_KEYS, PARENT_ID

Method Summary

int	getTotalItemCount() Gets the total number of items in the container, not to be confused with IContainer.getItemCount().
int	getUnreadItemCount() Gets the total number of 'unread' items in the container.

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

Field Detail

KEYID_TOTAL_ITEM_COUNT

public static final int KEYID_TOTAL_ITEM_COUNT

The int ID for the TOTAL_ITEM_COUNT key.

See Also:

Constant Field Values

KEYID_UNREAD_ITEM_COUNT

public static final int KEYID_UNREAD_ITEM_COUNT

The int ID for the UNREAD_ITEM_COUNT key.

See Also:

Constant Field Values

TOTAL_ITEM_COUNT

public static final Key TOTAL_ITEM_COUNT

The key representing the total number of items in a container. The total number of items consists of all immediate non-container, visible children.

UNREAD_ITEM_COUNT

public static final Key UNREAD_ITEM_COUNT

The key representing the total number of unread, visible items in a container.

CLASS

public static final ContainerClass CLASS

The container class for an IGroupwareContainer.

Method Detail

getTotalItemCount

public int getTotalItemCount()
                      throws CollaborationException

Gets the total number of items in the container, not to be confused with IContainer.getItemCount(). This method is preferred as it uses a property; the items do not have to be fetched.

Returns:

the total number of items

Throws:

CollaborationException - if there was an error getting the number of items

getUnreadItemCount

public int getUnreadItemCount()
                       throws CollaborationException

Gets the total number of 'unread' items in the container.

Returns:

the total number of unread items

Throws:

CollaborationException - if there was an error getting the number of unread items