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

This session provides methods for retrieving Ontology objects. The Ontology represents a collection of Subjects.

This session defines views that offer differing behaviors when retrieving multiple objects.

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

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. For example, a browsing application may only need to examine the Ontologies it can access, without breaking execution. However, an administrative application may require all Ontology elements to be available.

Ontologies may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the Ontology.

MethodcanLookupOntologies
Description

Tests if this user can perform Ontology lookups. 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 lookup operations to unauthorized users.

Returnboolean false if lookup methods are 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 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.
MethodgetOntology
Description

Gets the Ontology specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Ontology may have a different Id than requested, such as the case where a duplicate Id was assigned to an Ontology and retained for compatility.

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

Gets an OntologyList corresponding to the given IdList. In plenary mode, the returned list contains all of the ontologies specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Ontology objects may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListontologyIdsthe list of Ids to retrieve
Returnosid.ontology.OntologyListthe returned Ontology list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT ontologyIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOntologiesByGenusType
Description

Gets an OntologyList corresponding to the given ontology genus Type which does not include ontologies of types derived from the specified Type. In plenary mode, the returned list contains all known ontologies or an error results. Otherwise, the returned list may contain only those ontologies that are accessible through this session.

Parametersosid.type.TypeontologyGenusTypean ontology genus type
Returnosid.ontology.OntologyListthe returned Ontology list
ErrorsNULL_ARGUMENT ontologyGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOntologiesByParentGenusType
Description

Gets an OntologyList corresponding to the given ontology genus Type and include any additional ontologies with genus types derived from the specified Type. In plenary mode, the returned list contains all known ontologies or an error results. Otherwise, the returned list may contain only those ontologies that are accessible through this session.

Parametersosid.type.TypeontologyGenusTypean ontology genus type
Returnosid.ontology.OntologyListthe returned Ontology list
ErrorsNULL_ARGUMENT ontologyGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOntologiesByRecordType
Description

Gets an OntologyList containing the given ontology record Type. In plenary mode, the returned list contains all known ontologies or an error results. Otherwise, the returned list may contain only those ontologies that are accessible through this session.

Parametersosid.type.TypeontologyRecordTypean ontology record type
Returnosid.ontology.OntologyListthe returned Ontology list
ErrorsNULL_ARGUMENT ontologyRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOntologiesByProvider
Description

Gets an OntologyList for the given provider. In plenary mode, the returned list contains all known ontologies or an error results. Otherwise, the returned list may contain only those ontologies that are accessible through this session.

Parametersosid.id.IdresourceIda resource Id
Returnosid.ontology.OntologyListthe returned Ontology list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOntologies
Description

Gets all Ontologies. In plenary mode, the returned list contains all known ontologies or an error results. Otherwise, the returned list may contain only those ontologies that are accessible through this session.

Returnosid.ontology.OntologyListan OntologyList
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.