OSID Logo
OSID Specifications
checklist package
Version 3.0.0
Release Candidate Preview
Interfaceosid.checklist.TodoForm
Implementsosid.OsidObjectForm
osid.OsidContainableForm
osid.OsidTemporalForm
osid.OsidFederateableForm
Description

This is the form for creating and updating Todo objects. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the TodoAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

MethodgetCompleteMetadata
Description

Gets the metadata for the completed status.

Returnosid.Metadatametadata for the completed status
CompliancemandatoryThis method must be implemented.
MethodsetComplete
Description

Sets the completed status.

Parametersbooleancompletethe new completed status
ErrorsINVALID_ARGUMENT complete is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearComplete
Description

Clears the complete status.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetPriorityMetadata
Description

Gets the metadata for the priority.

Returnosid.Metadatametadata for the priority
CompliancemandatoryThis method must be implemented.
MethodsetPriority
Description

Sets the priority.

Parametersosid.type.TypepriorityTypethe new priority
ErrorsINVALID_ARGUMENT priorityType is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT priorityType is null
CompliancemandatoryThis method must be implemented.
MethodclearPriority
Description

Clears the priority.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetDueDateMetadata
Description

Gets the metadata for the due date.

Returnosid.Metadatametadata for the due date
CompliancemandatoryThis method must be implemented.
MethodsetDueDate
Description

Sets the due date.

Parametersosid.calendaring.DateTimedatethe new due date
ErrorsINVALID_ARGUMENT date is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT date is null
CompliancemandatoryThis method must be implemented.
MethodclearDueDate
Description

Clears the due date.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetDependenciesMetadata
Description

Gets the metadata for the dependencies.

Returnosid.Metadatametadata for the dependencies
CompliancemandatoryThis method must be implemented.
MethodsetDependencies
Description

Sets the dependencies.

Parametersosid.id.Id[]todoIdsthe new dependencies
ErrorsINVALID_ARGUMENT todoIds is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT todoIds is null
CompliancemandatoryThis method must be implemented.
MethodclearDependencies
Description

Clears the dependencies.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetTodoFormRecord
Description

Gets the TodoFormRecord corresponding to the given todo record Type.

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