OSID Logo
OSID Specifications
rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.rules.EngineSearchOrder
Implementsosid.OsidCatalogSearchOrder
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.TypeengineRecordTypean engine record type
Returnosid.rules.records.EngineSearchOrderRecordthe engine search order record
ErrorsNULL_ARGUMENT engineRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(engineRecordType) is false
CompliancemandatoryThis method must be implemented.