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

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

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

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.
MethodgetSubjectQuery
Description

Gets a subject query.

Returnosid.ontology.SubjectQuerythe subject query
CompliancemandatoryThis method must be implemented.
MethodgetSubjectSearchOrder
Description

Gets a subject search order.

Returnosid.ontology.SubjectSearchOrderthe subject search order
CompliancemandatoryThis method must be implemented.
MethodapplySubjectQuery
Description

Applies a subject query to this ontology.

Parametersosid.ontology.SubjectQuerysubjectQuerythe subject query
ErrorsNULL_ARGUMENT subjectQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED subjectQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectSubjectQuery
Description

Gets a subject query inspector for this ontology.

Returnosid.ontology.SubjectQueryInspectorthe subject query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplySubjectSequencing
Description

Applies a subject search order to this ontology.

Parametersosid.ontology.SubjectSearchOrdersubjectSearchOrderthe subject search order
ErrorsNULL_ARGUMENT subjectSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED subjectSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetSubjectQueryFromInspector
Description

Gets a subject query from an inspector.

Parametersosid.ontology.SubjectQueryInspectorsubjectQueryInspectora subject query inspector
Returnosid.ontology.SubjectQuerythe subject query
ErrorsNULL_ARGUMENT subjectQueryInspector is null
UNSUPPORTED subjectQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.