OSID Logo
OSID Specifications
ontology rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ontology.rules.RelevancyEnablerSearchResults
Implementsosid.OsidSearchResults
Description

This interface provides a means to capture results of a search.

MethodgetRelevancyEnablers
Description

Gets the RelevancyEnablerList resulting from a search.

Returnosid.ontology.rules.RelevancyEnablerListthe relevancy enabler list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetRelevancyEnablerQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.ontology.rules.RelevancyEnablerQueryInspectorthe relevancy enabler query inspector
CompliancemandatoryThis method must be implemented.
MethodgetRelevancyEnablerSearchResultsRecord
Description

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

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