com.compoze.collab.groupware
Interface ITasksContainer

All Superinterfaces

IContainer, IGroupwareContainer, IItem, Serializable

public interface ITasksContainer
extends IGroupwareContainer

Container class that holds tasks.

Field Summary

static ContainerClass

CLASS The ContainerClass that represents an ITasksContainer.

Fields inherited from interface com.compoze.collab.groupware.IGroupwareContainer

KEYID_TOTAL_ITEM_COUNT, KEYID_UNREAD_ITEM_COUNT, TOTAL_ITEM_COUNT, UNREAD_ITEM_COUNT

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

ITask[]	getTasks() Gets all of the tasks in the container using the default keys specified for an ITask.
ITask[]	getTasks(QueryProfile queryProfile) Gets all of the tasks in the container matching the specified QueryProfile.
ITaskList	getTasks(QueryProfile queryProfile, int iPageSize, int iPage) Gets tasks in the container given a number of tasks per 'page' and a page number.

Methods inherited from interface com.compoze.collab.groupware.IGroupwareContainer

getTotalItemCount, getUnreadItemCount

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

CLASS

static final ContainerClass CLASS

The ContainerClass that represents an ITasksContainer.

Method Detail

getTasks

ITask[] getTasks()
                 throws CollaborationException

Gets all of the tasks in the container using the default keys specified for an ITask.

Returns

the tasks (empty array if there are no tasks, never null)

Throws

CollaborationException

getTasks

ITask[] getTasks(QueryProfile queryProfile)
                 throws CollaborationException

Gets all of the tasks in the container matching the specified QueryProfile.

Parameters

queryProfile - the query profile to use when getting tasks

Returns

the tasks (empty array if there are no tasks, never null)

Throws

CollaborationException

getTasks

ITaskList getTasks(QueryProfile queryProfile,
                   int iPageSize,
                   int iPage)
                   throws CollaborationException

Gets tasks in the container given a number of tasks 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 tasks

iPageSize - the count of tasks that makes a 'page' (<=0 for all)

iPage - the page number to fetch (must be >=1)

Returns

the tasks

Throws

CollaborationException