OSID Logo
OSID Specifications
ontology package
Version 3.1.0
Interfaceosid.ontology.RelevancySearch
Implementsosid.OsidSearch
Used Byosid.ontology.RelevancySearchSession
Description

RelevancySearch defines the interface for specifying relevancy search options.

MethodsearchAmongRelevancies
Description

Execute this search among the given list of relevancies.

Parametersosid.id.IdListrelevancyIds list of relevancies
ErrorsNULL_ARGUMENT relevancyIds is null
Compliancemandatory This method must be implemented.
MethodorderRelevancyResults
Description

Specify an ordering to the search results.

Parametersosid.ontology.RelevancySearchOrderrelevancySearchOrder relevancy search order
ErrorsNULL_ARGUMENT relevancySearchOrder is null
UNSUPPORTED relevancySearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetRelevancySearchRecord
Description

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

Parametersosid.type.TyperelevancySearchRecordType a relevancy search record type
Returnosid.ontology.records.RelevancySearchRecord the relevancy search record
ErrorsNULL_ARGUMENT relevancySearchRecordType is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED hasRecordType(relevancySearchRecordType) is false
Compliancemandatory This method must be implemented.