Interface EngineSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface EngineSearch
extends OsidSearch

The search interface for governing engine searches.

Method Summary

Modifier and Type	Method	Description
EngineSearchRecord	getEngineSearchRecord(Type engineSearchRecordType)	Gets the engine search record corresponding to the given engine search record Type.
void	orderEngineResults(EngineSearchOrder engineSearchOrder)	Specify an ordering to the search results.
void	searchAmongEngines(IdList engineIds)	Execute this search among the given list of engines.

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

searchAmongEngines

void searchAmongEngines(IdList engineIds)

Execute this search among the given list of engines.

Parameters:

engineIds - list of engines

Throws:

NullArgumentException - engineIds is null

Compliance:

mandatory - This method must be implemented.

orderEngineResults

void orderEngineResults(EngineSearchOrder engineSearchOrder)

Specify an ordering to the search results.

Parameters:

engineSearchOrder - engine search order

Throws:

NullArgumentException - engineSearchOrder is null

UnsupportedException - engineSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getEngineSearchRecord

EngineSearchRecord getEngineSearchRecord(Type engineSearchRecordType)
                                  throws OperationFailedException

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

Parameters:

engineSearchRecordType - an engine search record type

Returns:

the engine search record

Throws:

NullArgumentException - engineSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(engineSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.