Interface ControllerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ControllerSearch
extends OsidSearch

The search interface for governing controller searches.

Method Summary

Modifier and Type	Method	Description
ControllerSearchRecord	getControllerSearchRecord(Type controllerSearchRecordType)	Gets the controller search record corresponding to the given controller search record Type .This method is used to retrieve an object implementing the requested record.
void	orderControllerResults(ControllerSearchOrder controllerSearchOrder)	Specify an ordering to the search results.
void	searchAmongControllers(IdList controllerIds)	Execute this search among the given list of controllers.

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

searchAmongControllers

void searchAmongControllers(IdList controllerIds)

Execute this search among the given list of controllers.

Parameters:

controllerIds - list of controllers

Throws:

NullArgumentException - controllerIds is null

Compliance:

mandatory - This method must be implemented.

orderControllerResults

void orderControllerResults(ControllerSearchOrder controllerSearchOrder)

Specify an ordering to the search results.

Parameters:

controllerSearchOrder - controller search order

Throws:

NullArgumentException - controllerSearchOrder is null

UnsupportedException - controllerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getControllerSearchRecord

ControllerSearchRecord getControllerSearchRecord(Type controllerSearchRecordType)
                                          throws OperationFailedException

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

Parameters:

controllerSearchRecordType - a controller search record type

Returns:

the controller search record

Throws:

NullArgumentException - controllerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(controllerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.