OSID Logo
OSID Specifications
ontology package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ontology.RelevancyQuerySession
Implementsosid.OsidSession
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.

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.

MethodgetOntologyId
Description

Gets the Ontology Id associated with this session.

Returnosid.id.Idthe Ontology Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetOntology
Description

Gets the Ontology associated with this session.

Returnosid.ontology.Ontologythe Ontology associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSearchRelevancies
Description

Tests if this user can perform Relevancy searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer search operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedOntologyView
Description

Federates the view for methods in this session. A federated view will include relevancies in ontologies which are children of this ontology in the ontology hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedOntologyView
Description

Isolates the view for methods in this session. An isolated view restricts searches to this ontology only.

CompliancemandatoryThis method is must be implemented.
MethodgetRelevancyQuery
Description

Gets a relevancy query.

Returnosid.ontology.RelevancyQuerythe relevancy query
CompliancemandatoryThis method must be implemented.
MethodgetRelevanciesByQuery
Description

Gets a list of relevancies matching the given relevancy query.

Parametersosid.ontology.RelevancyQueryrelevancyQuerythe relevancy query
Returnosid.ontology.RelevancyListthe returned RelevancyList
ErrorsNULL_ARGUMENT relevancyQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED relevancyQuery is not of this service
CompliancemandatoryThis method must be implemented.