OSID Logo
OSID Specifications
ontology package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ontology.RelevancySmartOntologySession
Implementsosid.OsidSession
Description

This session manages queries and sequencing to create "smart" dynamic catalogs. A RelevancyQuery can be retrieved from this session and mapped to this Ontology to create a virtual collection of Relevancies. The entries may be sequenced using the RelevancySearchOrder from this session.

This Ontology has a default query that matches any relevancy and a default search order that specifies no sequencing. The queries may be examined using a RelevancyQueryInspector. The query may be modified by converting the inspector back to a 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.
MethodcanManageSmartOntologies
Description

Tests if this user can manage smart ontologies. 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 smart operations.

Returnboolean false if smart ontology methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRelevancyQuery
Description

Gets a relevancy query.

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

Gets a relevancy search order.

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

Applies a relevancy query to this ontology.

Parametersosid.ontology.RelevancyQueryrelevancyQuerythe relevancy query
ErrorsNULL_ARGUMENT relevancyQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED relevancyQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectRelevancyQuery
Description

Gets a relevancy query inspector for this ontology.

Returnosid.ontology.RelevancyQueryInspectorthe relevancy query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyRelevancySequencing
Description

Applies a relevancy search order to this ontology.

Parametersosid.ontology.RelevancySearchOrderrelevancySearchOrderthe relevancy search order
ErrorsNULL_ARGUMENT relevancySearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED relevancySearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetRelevancyQueryFromInspector
Description

Gets a relevancy query from an inspector.

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.