OSID Logo
OSID Specifications
ontology package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ontology.RelevancySearch
Implementsosid.OsidSearch
Description

RelevancySearch defines the interface for specifying relevancy search options.

MethodsearchAmongRelevancies
Description

Execute this search among the given list of relevancies.

Parametersosid.id.IdListrelevancyIdslist of relevancies
ErrorsNULL_ARGUMENT relevancyIds is null
CompliancemandatoryThis method must be implemented.
MethodorderRelevancyResults
Description

Specify an ordering to the search results.

Parametersosid.ontology.RelevancySearchOrderrelevancySearchOrderrelevancy search order
ErrorsNULL_ARGUMENT relevancySearchOrder is null
UNSUPPORTED relevancySearchOrder is not of this service
CompliancemandatoryThis 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.TyperelevancySearchRecordTypea relevancy search record type
Returnosid.ontology.records.RelevancySearchRecordthe relevancy search record
ErrorsNULL_ARGUMENT relevancySearchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(relevancySearchRecordType) is false
CompliancemandatoryThis method must be implemented.