OSID Logo
OSID Specifications
checklist package
Version 3.0.0
Release Candidate Preview
Interfaceosid.checklist.TodoSearchSession
Implementsosid.checklist.TodoQuerySession
Description

This session provides methods for searching Todo objects. The search query is constructed using the TodoQuery. The todo record Type also specifies the record for the todo query.

getTodosByQuery() is the basic search method and returns a list of Todo elements. A more advanced search may be performed with getTodosBySearch(). It accepts a TodoSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getTodosBySearch() returns a TodoSearchResults that can be used to access the resulting TodoList or be used to perform a search within the result set through TodoSearch.

Todos may have a query record indicated by their respective record types. The query record is accessed via the TodoQuery. The returns in this session may not be cast directly to these interfaces.

MethodgetTodoSearch
Description

Gets a todo search.

Returnosid.checklist.TodoSearchthe todo search
CompliancemandatoryThis method must be implemented.
MethodgetTodoSearchOrder
Description

Gets a todo search order. The TodoSearchOrder is supplied to a TodoSearch to specify the ordering of results.

Returnosid.checklist.TodoSearchOrderthe todo search order
CompliancemandatoryThis method must be implemented.
MethodgetTodosBySearch
Description

Gets the search results matching the given search.

Parametersosid.checklist.TodoQuerytodoQuerythe todo query
osid.checklist.TodoSearchtodoSearchthe todo search
Returnosid.checklist.TodoSearchResultsthe search results
ErrorsNULL_ARGUMENT todoQuery or todoSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED todoQuery or todoSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetTodoQueryFromInspector
Description

Gets an entry query from an inspector. The inspector is available from an TodoSearchResults.

Parametersosid.checklist.TodoQueryInspectortodoQueryInspectora todo query inspector
Returnosid.checklist.TodoQuerythe entry query
ErrorsNULL_ARGUMENT todoQueryInspector is null
UNSUPPORTED todoQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.