OSID Logo
OSID Specifications
checklist package
Version 3.1.0
Interfaceosid.checklist.TodoSearch
Implementsosid.OsidSearch
Used Byosid.checklist.TodoSearchSession
Description

The search interface for governing todo searches.

MethodsearchAmongTodos
Description

Execute this search among the given list of todos.

Parametersosid.id.IdListtodoIds list of todos
ErrorsNULL_ARGUMENT todoIds is null
Compliancemandatory This method must be implemented.
MethodorderTodoResults
Description

Specify an ordering to the search results.

Parametersosid.checklist.TodoSearchOrdertodoSearchOrder todo search order
ErrorsNULL_ARGUMENT todoSearchOrder is null
UNSUPPORTED todoSearchOrder is not of this service
Compliancemandatory This 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.TypetodoSearchRecordType a todo search record type
Returnosid.checklist.records.TodoSearchRecord the todo search record
ErrorsNULL_ARGUMENT todoSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(todoSearchRecordType) is false
Compliancemandatory This method must be implemented.