com.compoze.collab.domino
Interface ITaskNotice

All Superinterfaces:

IGroupwareItem, IItem, IMessagingItem, INotice, ITask, java.io.Serializable

All Known Subinterfaces:

ITaskAssignment

public interface ITaskNotice

extends ITask, INotice

Interface for a notice of an appointment update.

Field Summary

static Key	APPOINTMENT_ID Key that represents the appointment ID.
static ItemClass	CLASS The item class of IDominoTask.
static int	KEYID_APPOINTMENT_ID The int ID for the APPOINTMENT_ID key.
static int	KEYID_RESCHEDULE_SERIES The int RESCHEDULE_SERIES code.
static int	KEYID_TASK_NOTICE_TYPE The int ID for the TASK_NOTICE_TYPE key.
static Key	RESCHEDULE_SERIES Key that represents the RescheduleWhich variable.
static Key	TASK_NOTICE_TYPE Key that represents the notice type.

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

DATE_COMPLETED, DUE_DATE, IS_RECURRING, KEYID_DATE_COMPLETED, KEYID_DUE_DATE, KEYID_IS_RECURRING, KEYID_PERCENT_COMPLETE, KEYID_START_DATE, KEYID_STATUS, PERCENT_COMPLETE, START_DATE, STATUS

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

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

Fields inherited from interface com.compoze.collab.domino.INotice

KEYID_STATUS_UPDATE, KEYID_TOPIC, STATUS_UPDATE, TOPIC

Method Summary

java.lang.String	getAppointmentID() Gets the document id of the appointment that this notice is generated.
TaskNoticeType	getTaskNoticeType() Gets the task notice type.
java.lang.String	getTitle() Gets the title for the notice using the default locale.

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

getDateCompleted, getDueDate, getPercentComplete, getStartDate, getStatus, isRecurring, markComplete, setDateCompleted, setDueDate, setDueDate, setPercentComplete, setStartDate, setStartDate, setStatus

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

Methods inherited from interface com.compoze.collab.domino.INotice

getStatusUpdate, getTopic

Field Detail

CLASS

public static final ItemClass CLASS

The item class of IDominoTask.

KEYID_TASK_NOTICE_TYPE

public static final int KEYID_TASK_NOTICE_TYPE

The int ID for the TASK_NOTICE_TYPE key.

KEYID_APPOINTMENT_ID

public static final int KEYID_APPOINTMENT_ID

The int ID for the APPOINTMENT_ID key.

KEYID_RESCHEDULE_SERIES

public static final int KEYID_RESCHEDULE_SERIES

The int RESCHEDULE_SERIES code.

TASK_NOTICE_TYPE

public static final Key TASK_NOTICE_TYPE

Key that represents the notice type.

APPOINTMENT_ID

public static final Key APPOINTMENT_ID

Key that represents the appointment ID.

RESCHEDULE_SERIES

public static final Key RESCHEDULE_SERIES

Key that represents the RescheduleWhich variable.

Method Detail

getAppointmentID

public java.lang.String getAppointmentID()
                                  throws CollaborationException

Gets the document id of the appointment that this notice is generated.

Returns:

the appointment id

See Also:

APPOINTMENT_ID

getTaskNoticeType

public TaskNoticeType getTaskNoticeType()
                                 throws CollaborationException

Gets the task notice type.

Returns:

the task notice type or null if not recognized

See Also:

// * @see #CHAIR

getTitle

public java.lang.String getTitle()
                          throws CollaborationException

Gets the title for the notice using the default locale.

Specified by:

getTitle in interface INotice

Returns:

the title for the notice

See Also:

TASK_NOTICE_TYPE