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

The search interface for governing relevancy enabler searches.

MethodsearchAmongRelevancyEnablers
Description

Execute this search among the given list of relevancy enablers.

Parametersosid.id.IdListrelevancyEnablerIdslist of relevancy enablers
ErrorsNULL_ARGUMENT relevancyEnablerIds is null
CompliancemandatoryThis method must be implemented.
MethodorderRelevancyEnablerResults
Description

Specify an ordering to the search results.

Parametersosid.ontology.rules.RelevancyEnablerSearchOrderrelevancyEnablerSearchOrderrelevancy enabler search order
ErrorsNULL_ARGUMENT relevancyEnablerSearchOrder is null
UNSUPPORTED relevancyEnablerSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetRelevancyEnablerSearchRecord
Description

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

Parametersosid.type.TyperelevancyEnablerSearchRecordTypea relevancy enabler search record type
Returnosid.ontology.rules.records.RelevancyEnablerSearchRecordthe relevancy enabler search record
ErrorsNULL_ARGUMENT relevancyEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(relevancyEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.