Interface ModuleSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ModuleSearch
extends OsidSearch

The search interface for governing module searches.

Method Summary

Modifier and Type	Method	Description
ModuleSearchRecord	getModuleSearchRecord(Type moduleSearchRecordType)	Gets the module search record corresponding to the given module search record Type .
void	orderModuleResults(ModuleSearchOrder moduleSearchOrder)	Specify an ordering to the search results.
void	searchAmongModules(IdList moduleIds)	Execute this search among the given list of modules.

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

searchAmongModules

void searchAmongModules(IdList moduleIds)

Execute this search among the given list of modules.

Parameters:

moduleIds - list of modules

Throws:

NullArgumentException - moduleIds is null

Compliance:

mandatory - This method must be implemented.

orderModuleResults

void orderModuleResults(ModuleSearchOrder moduleSearchOrder)

Specify an ordering to the search results.

Parameters:

moduleSearchOrder - module search order

Throws:

NullArgumentException - moduleSearchOrder is null

UnsupportedException - moduleSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getModuleSearchRecord

ModuleSearchRecord getModuleSearchRecord(Type moduleSearchRecordType)
                                  throws OperationFailedException

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

Parameters:

moduleSearchRecordType - a module search record type

Returns:

the module search record

Throws:

NullArgumentException - moduleSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(moduleSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.