OSID Logo
OSID Specifications
search package
Version 3.0.0
Release Candidate Preview
Interfaceosid.search.EngineSearch
Implementsosid.OsidSearch
Description

The search interface for governing engine searches.

MethodsearchAmongEngines
Description

Execute this search among the given list of engines.

Parametersosid.id.IdListengineIdslist of engines
ErrorsNULL_ARGUMENT engineIds is null
CompliancemandatoryThis method must be implemented.
MethodorderEngineResults
Description

Specify an ordering to the search results.

Parametersosid.search.EngineSearchOrderengineSearchOrderengine search order
ErrorsNULL_ARGUMENT engineSearchOrder is null
UNSUPPORTED engineSearchOrder is not of this service
CompliancemandatoryThis 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.TypeengineSearchRecordTypean engine search record type
Returnosid.search.records.EngineSearchRecordthe engine search record
ErrorsNULL_ARGUMENT engineSearchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(engineSearchRecordType) is false
CompliancemandatoryThis method must be implemented.