OSID Logo
OSID Specifications
ontology rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ontology.rules.RelevancyEnablerSearchSession
Implementsosid.ontology.rules.RelevancyEnablerQuerySession
Description

This session provides methods for searching among RelevancyEnabler objects. The search query is constructed using the RelevancyEnableryQuery.

getRelevancyEnablersByQuery() is the basic search method and returns a list of RelevancyEnablers. A more advanced search may be performed with getRelevancyEnablersBySearch(). It accepts a RelevancyEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getRelevancyEnablersBySearch() returns a RelevancyEnablerSearchResults that can be used to access the resulting RelevancyEnablerList or be used to perform a search within the result set through RelevancyEnablerSearch.

This session defines views that offer differing behaviors for searching.

  • federated ontology view: searches include relevancy enablers in ontologies of which this ontology is an ancestor in the ontology hierarchy
  • isolated ontology view: searches are restricted to relevancy enablers in this ontology

RelevancyEnablers may have a query record indicated by their respective record types. The query record is accessed via the RelevancyEnablerQuery.

MethodgetRelevancyEnablerSearch
Description

Gets a relevancy enabler search.

Returnosid.ontology.rules.RelevancyEnablerSearchthe relevancy enabler search
CompliancemandatoryThis method must be implemented.
MethodgetRelevancyEnablerSearchOrder
Description

Gets a relevancy enabler search order. The RelevancyEnablerSearchOrder is supplied to a RelevancyEnablerSearch to specify the ordering of results.

Returnosid.ontology.rules.RelevancyEnablerSearchOrderthe relevancy enabler search order
CompliancemandatoryThis method must be implemented.
MethodgetRelevancyEnablersBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.ontology.rules.RelevancyEnablerQueryrelevancyEnablerQuerythe relevancy enabler query
osid.ontology.rules.RelevancyEnablerSearchrelevancyEnablerSearchthe relevancy enabler search
Returnosid.ontology.rules.RelevancyEnablerSearchResultsthe returned search results
ErrorsNULL_ARGUMENT relevancyEnablerQuery or relevancyEnablerSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED relevancyEnablerQuery or relevancyEnablerSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetRelevancyEnablerQueryFromInspector
Description

Gets a relevancy enabler query from an inspector. The inspector is available from a RelevancyEnablerSearchResults.

Parametersosid.ontology.rules.RelevancyEnablerQueryInspectorrelevancyEnablerQueryInspectora relevancy enabler query inspector
Returnosid.ontology.rules.RelevancyEnablerQuerythe relevancy enabler query
ErrorsNULL_ARGUMENT relevancyEnablerQueryInspector is null
UNSUPPORTED relevancyEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.