OSID Logo
OSID Specifications
search package
Version 3.1.0
Interfaceosid.search.EngineSearch
Implementsosid.OsidSearch
Used Byosid.search.EngineSearchSession
Description

The search interface for governing engine searches.

MethodsearchAmongEngines
Description

Execute this search among the given list of engines.

Parametersosid.id.IdListengineIds list of engines
ErrorsNULL_ARGUMENT engineIds is null
Compliancemandatory This method must be implemented.
MethodorderEngineResults
Description

Specify an ordering to the search results.

Parametersosid.search.EngineSearchOrderengineSearchOrder engine search order
ErrorsNULL_ARGUMENT engineSearchOrder is null
UNSUPPORTED engineSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetEngineSearchRecord
Description

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.

Parametersosid.type.TypeengineSearchRecordType an engine search record type
Returnosid.search.records.EngineSearchRecord the engine search record
ErrorsNULL_ARGUMENT engineSearchRecordType is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED hasRecordType(engineSearchRecordType) is false
Compliancemandatory This method must be implemented.