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

This session manages queries and sequencing to create "smart" dynamic ontologies. A RelevancyEnablerQuery can be retrieved from this session and mapped to this Ontology to create a virtual collection of relevancy enablers. The relevancy enablers may be sequenced using the RelevancyEnablerSearchOrder from this session.

This Ontology has a default query that matches any relevancy enabler and a default search order that specifies no sequencing. The queries may be examined using a RelevancyEnablerQueryInspector. The query may be modified by converting the inspector back to a RelevancyEnablerQuery.

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
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 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 operations to unauthorized users.

Returnboolean false if smart ontology management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRelevancyEnablerQuery
Description

Gets a relevancy enabler query.

Returnosid.ontology.rules.RelevancyEnablerQuerythe relevancy enabler query
CompliancemandatoryThis method must be implemented.
MethodgetRelevancyEnablerSearchOrder
Description

Gets a relevancy enabler search order.

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

Applies a relevancy enabler query to this ontology.

Parametersosid.ontology.rules.RelevancyEnablerQueryrelevancyEnablerQuerythe relevancy enabler query
ErrorsNULL_ARGUMENT relevancyEnablerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED relevancyEnablerQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectRelevancyEnablerQuery
Description

Gets a relevancy enabler query inspector for this ontology.

Returnosid.ontology.rules.RelevancyEnablerQueryInspectorthe relevancy enabler query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyRelevancyEnablerSequencing
Description

Applies a relevancy enabler search order to this ontology.

Parametersosid.ontology.rules.RelevancyEnablerSearchOrderrelevancyEnablerSearchOrderthe relevancy enabler search order
ErrorsNULL_ARGUMENT relevancyEnablerSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED relevancyEnablerSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetRelevancyEnablerQueryFromInspector
Description

Gets a relevancy enabler query from an inspector.

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.