OSID Logo
OSID Specifications
ontology package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ontology.RelevancySearchSession
Implementsosid.ontology.RelevancyQuerySession
Description

This session provides methods for searching Relevancy objects. The search query is constructed using the RelevancyQuery. The relevancy record Type also specifies the record for the relevancy query.

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

This session defines views that offer differing behaviors for searching.

  • federated ontology view: searches include relevancies in ontologies of which this ontology is a ancestor in the ontology hierarchy
  • isolated ontology view: searches are restricted

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

MethodgetRelevancySearch
Description

Gets a relevancy search.

Returnosid.ontology.RelevancySearchthe relevancy search
CompliancemandatoryThis method must be implemented.
MethodgetRelevancySearchOrder
Description

Gets a relevancy search order. The RelevancySearchOrder is supplied to a RelevancySearch to specify the ordering of results.

Returnosid.ontology.RelevancySearchOrderthe relevancy search order
CompliancemandatoryThis method must be implemented.
MethodgetRelevanciesBySearch
Description

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

Parametersosid.ontology.RelevancyQueryrelevancyQuerythe relevancy query
osid.ontology.RelevancySearchrelevancySearchthe relevancy search
Returnosid.ontology.RelevancySearchResultsthe relevancy search results
ErrorsNULL_ARGUMENT relevancyQuery or relevancySearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED relevancySearch or relevancyQuery is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetRelevancyQueryFromInspector
Description

Gets a relevancy query from an inspector. The inspector is available from a RelevancySearchResults.

Parametersosid.ontology.RelevancyQueryInspectorrelevancyQueryInspectora relevancy query inspector
Returnosid.ontology.RelevancyQuerythe relevancy query
ErrorsNULL_ARGUMENT relevancyQueryInspector is null
UNSUPPORTED relevancyQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.