OSID Logo
OSID Specifications
ontology rules package
Version 3.1.0
Interfaceosid.ontology.rules.RelevancyEnablerSearchResults
Implementsosid.OsidSearchResults
Used Byosid.ontology.rules.RelevancyEnablerSearchSession
Description

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

MethodgetRelevancyEnablers
Description

Gets the RelevancyEnablerList resulting from a search.

Returnosid.ontology.rules.RelevancyEnablerList the relevancy enabler list
ErrorsILLEGAL_STATE list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetRelevancyEnablerQueryInspector
Description

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

Returnosid.ontology.rules.RelevancyEnablerQueryInspector the relevancy enabler query inspector
Compliancemandatory This 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.TyperelevancyEnablerSearchRecordType a relevancy enabler search record type
Returnosid.ontology.rules.records.RelevancyEnablerSearchResultsRecord the relevancy enabler search results record
ErrorsNULL_ARGUMENT relevancyEnablerSearchRecordType is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED hasRecordType(relevancyEnablerSearchRecordType) is false
Compliancemandatory This method must be implemented.