OSID Logo
OSID Specifications
checklist package
Version 3.0.0
Release Candidate Preview
Interfaceosid.checklist.TodoSearch
Implementsosid.OsidSearch
Description

The search interface for governing todo searches.

MethodsearchAmongTodos
Description

Execute this search among the given list of todos.

Parametersosid.id.IdListtodoIdslist of todos
ErrorsNULL_ARGUMENT todoIds is null
CompliancemandatoryThis method must be implemented.
MethodorderTodoResults
Description

Specify an ordering to the search results.

Parametersosid.checklist.TodoSearchOrdertodoSearchOrdertodo search order
ErrorsNULL_ARGUMENT todoSearchOrder is null
UNSUPPORTED todoSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetTodoSearchRecord
Description

Gets the todo search record corresponding to the given todo search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypetodoSearchRecordTypea todo search record type
Returnosid.checklist.records.TodoSearchRecordthe todo search record
ErrorsNULL_ARGUMENT todoSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(todoSearchRecordType) is false
CompliancemandatoryThis method must be implemented.