OSID Logo
OSID Specifications
checklist package
Version 3.1.0
Interfaceosid.checklist.TodoSearchResults
Implementsosid.OsidSearchResults
Used Byosid.checklist.TodoSearchSession
Description

This interface provides a means to capture results of a search.

MethodgetTodos
Description

Gets the todo list resulting from a search.

Returnosid.checklist.TodoList the todo list
ErrorsILLEGAL_STATE list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetTodoQueryInspector
Description

Gets the inspector for the query to examine the terns used in the search.

Returnosid.checklist.TodoQueryInspector the query inspector
Compliancemandatory This method must be implemented.
MethodgetTodoSearchResultsRecord
Description

Gets the todo search results 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.TodoSearchResultsRecord the todo search results record
ErrorsNULL_ARGUMENT todoSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(todoSearchRecordType) is false
Compliancemandatory This method must be implemented.