org.osid.checklist

Interface Todo

All Superinterfaces:

Browsable, Containable, Extensible, Federateable, Identifiable, OsidObject, Temporal

public interface Todo
extends OsidObject, Containable, Temporal, Federateable

A Todo represents a checklist item. A Todo is Temporal that may go into effect at a future date or expired when no longer applicable, skipped, or completed.

Method Summary

Methods

Modifier and Type	Method and Description
TodoList	getDependencies() Gets a list of todos on which this todo is dependent.
IdList	getDependencyIds() Gets a list of todo Ids on which this todo is dependent.
DateTime	getDueDate() Gets the due date.
Type	getPriority() Gets a priority of this item.
TodoRecord	getTodoRecord(Type todoRecordType) Gets the todo record corresponding to the given Todo record Type.
boolean	isComplete() Tests if this todo has been checked off.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Containable

isSequestered

Methods inherited from interface org.osid.Temporal

getEndDate, getStartDate, isEffective

Method Detail

isComplete

boolean isComplete()

Tests if this todo has been checked off.

Returns:

true if this todo is complete, false if not complete

Compliance:

mandatory - This method must be implemented.

getPriority

Type getPriority()

Gets a priority of this item.

Returns:

a priority type

Compliance:

mandatory - This method must be implemented.

getDueDate

DateTime getDueDate()

Gets the due date.

Returns:

a date

Compliance:

mandatory - This method must be implemented.

getDependencyIds

IdList getDependencyIds()

Gets a list of todo Ids on which this todo is dependent.

Returns:

a list of todo Ids

Compliance:

mandatory - This method must be implemented.

getDependencies

TodoList getDependencies()
                         throws OperationFailedException

Gets a list of todos on which this todo is dependent.

Returns:

a list of todos

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getTodoRecord

TodoRecord getTodoRecord(Type todoRecordType)
                         throws OperationFailedException

Gets the todo record corresponding to the given Todo record Type. This method is used to retrieve an object implementing the requested record. The todoRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(todoRecordType) is true .

Parameters:

todoRecordType - the type of todo record to retrieve

Returns:

the todo record

Throws:

NullArgumentException - todoRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(todoRecordType) is false

Compliance:

mandatory - This method must be implemented.