OSID Logo
OSID Specifications
checklist package
Version 3.0.0
Release Candidate Preview
Interfaceosid.checklist.Todo
Implementsosid.OsidObject
osid.Containable
osid.Temporal
osid.Federateable
Description

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.

MethodisComplete
Description

Tests if this todo has been checked off.

Returnboolean true if this todo is complete, false if not complete
CompliancemandatoryThis method must be implemented.
MethodgetPriority
Description

Gets a priority of this item.

Returnosid.type.Typea priority type
CompliancemandatoryThis method must be implemented.
MethodgetDueDate
Description

Gets the due date.

Returnosid.calendaring.DateTimea date
CompliancemandatoryThis method must be implemented.
MethodgetDependencyIds
Description

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

Returnosid.id.IdLista list of todo Ids
CompliancemandatoryThis method must be implemented.
MethodgetDependencies
Description

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

Returnosid.checklist.TodoLista list of todos
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetTodoRecord
Description

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 .

Parametersosid.type.TypetodoRecordTypethe type of todo record to retrieve
Returnosid.checklist.records.TodoRecordthe todo record
ErrorsNULL_ARGUMENT todoRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(todoRecordType) is false
CompliancemandatoryThis method must be implemented.