OSID Logo
OSID Specifications
rules package
Version 3.1.0
Interfaceosid.rules.EngineSearchOrder
Implementsosid.OsidCatalogSearchOrder
Used Byosid.rules.EngineSearchSession
Description

An interface for specifying the ordering of search results.

MethodgetEngineSearchOrderRecord
Description

Gets the engine search order record corresponding to the given engine record Type. Multiple retrievals return the same underlying object.

Parametersosid.type.TypeengineRecordType an engine record type
Returnosid.rules.records.EngineSearchOrderRecord the engine search order record
ErrorsNULL_ARGUMENT engineRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(engineRecordType) is false
Compliancemandatory This method must be implemented.