Interface TodoProducerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface TodoProducerSearch
extends OsidSearch

The search interface for governing todo producer searches.

Method Summary

Modifier and Type	Method	Description
TodoProducerSearchRecord	getTodoProducerSearchRecord(Type todoProducerSearchRecordType)	Gets the todo producer search record corresponding to the given todo producer search record Type .This method is used to retrieve an object implementing the requested record.
void	orderTodoProducerResults(TodoProducerSearchOrder todoProducerSearchOrder)	Specify an ordering to the search results.
void	searchAmongTodoProducers(IdList todoProducerIds)	Execute this search among the given list of todo producers.

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

searchAmongTodoProducers

void searchAmongTodoProducers(IdList todoProducerIds)

Execute this search among the given list of todo producers.

Parameters:

todoProducerIds - list of todo producers

Throws:

NullArgumentException - todoProducerIds is null

Compliance:

mandatory - This method must be implemented.

orderTodoProducerResults

void orderTodoProducerResults(TodoProducerSearchOrder todoProducerSearchOrder)

Specify an ordering to the search results.

Parameters:

todoProducerSearchOrder - todo producer search order

Throws:

NullArgumentException - todoProducerSearchOrder is null

UnsupportedException - todoProducerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getTodoProducerSearchRecord

TodoProducerSearchRecord getTodoProducerSearchRecord(Type todoProducerSearchRecordType)
                                              throws OperationFailedException

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

Parameters:

todoProducerSearchRecordType - a todo producer search record type

Returns:

the todo producer search record

Throws:

NullArgumentException - todoProducerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(todoProducerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.