Interface TodoSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface TodoSearch
extends OsidSearch

The search interface for governing todo searches.

Method Summary

Modifier and Type	Method	Description
TodoSearchRecord	getTodoSearchRecord(Type todoSearchRecordType)	Gets the todo search record corresponding to the given todo search record Type.
void	orderTodoResults(TodoSearchOrder todoSearchOrder)	Specify an ordering to the search results.
void	searchAmongTodos(IdList todoIds)	Execute this search among the given list of todos.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongTodos

void searchAmongTodos(IdList todoIds)

Execute this search among the given list of todos.

Parameters:

todoIds - list of todos

Throws:

NullArgumentException - todoIds is null

Compliance:

mandatory - This method must be implemented.

orderTodoResults

void orderTodoResults(TodoSearchOrder todoSearchOrder)

Specify an ordering to the search results.

Parameters:

todoSearchOrder - todo search order

Throws:

NullArgumentException - todoSearchOrder is null

UnsupportedException - todoSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getTodoSearchRecord

TodoSearchRecord getTodoSearchRecord(Type todoSearchRecordType)
                              throws OperationFailedException

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.

Parameters:

todoSearchRecordType - a todo search record type

Returns:

the todo search record

Throws:

NullArgumentException - todoSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(todoSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.