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

This session provides methods to retrieve Relevancy to Ontology mappings. A Relevancy may appear in multiple Ontologies. Each Ontology may have its own authorizations governing who is allowed to look at it.

This lookup session defines two views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
MethodcanLookupRelevancyOntologyMappings
Description

Tests if this user can perform lookups of relevancy/ontology mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeOntologyView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryOntologyView
Description

A complete view of the Relevancy and Ontology returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethodgetRelevancyIdsByOntology
Description

Gets the list of Relevancy Ids associated with an Ontology.

Parametersosid.id.IdontologyId Id of the Ontology
Returnosid.id.IdListlist of related ontology Ids
ErrorsNOT_FOUND ontologyId is not found
NULL_ARGUMENT ontologyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRelevanciesByOntology
Description

Gets the list of Relevancies associated with an Ontology.

Parametersosid.id.IdontologyId Id of the Ontology
Returnosid.ontology.RelevancyListlist of related relevancy Ids
ErrorsNOT_FOUND ontologyId is not found
NULL_ARGUMENT ontologyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRelevancyIdsByOntologies
Description

Gets the list of Relevancy Ids corresponding to a list of Ontologies.

Parametersosid.id.IdListontologyIdslist of ontology Ids
Returnosid.id.IdListlist of relevancy Ids
ErrorsNULL_ARGUMENT ontologyIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRelevanciesByOntologies
Description

Gets the list of Relevancies corresponding to a list of Ontologies.

Parametersosid.id.IdListontologyIdslist of ontology Ids
Returnosid.ontology.RelevancyListlist of relevancies
ErrorsNULL_ARGUMENT ontologyIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOntologyIdsByRelevancy
Description

Gets the list of Ontology Ids mapped to a Relevancy

Parametersosid.id.IdrelevancyId Id of a Relevancy
Returnosid.id.IdListlist of ontology Ids
ErrorsNOT_FOUND relevancyId is not found
NULL_ARGUMENT relevancyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOntologiesByRelevancy
Description

Gets the list of Ontologies mapped to a Relevancy.

Parametersosid.id.IdrelevancyId Id of a Relevancy
Returnosid.ontology.OntologyListlist of ontologies
ErrorsNOT_FOUND relevancyId is not found
NULL_ARGUMENT relevancyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.