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

This session provides methods to manage Id to Ontology mappings. Arbitrary Ids may be used to offer a restricted ontology to allow an arbitrary Id to be used in the SubjectLookupSession or the SubjectHierarchySession. Only one ontology can be assigned to an Id.

MethodcanAssignOntologies
Description

Tests if this user can manage of id/ontology mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known assignment methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may wish not to offer mapping functions to unauthorized users.

Returnboolean false if managing mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodassignOntology
Description

Assigns an Id to an ontology.

Parametersosid.id.Idid an Id
osid.id.IdontologyId Id of the Ontology
ErrorsNOT_FOUND ontologyId is not found
NULL_ARGUMENT id or ontologyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignOntology
Description

Unassigns an Id from an ontology.

Parametersosid.id.Idid an Id
osid.id.IdontologyId Id of the Ontology
ErrorsNOT_FOUND id not assigned to ontologyId
NULL_ARGUMENT id or ontologyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOntology
Description

Gets the ontology to which the Id is assigned.

Parametersosid.id.Idid an Id
ErrorsNOT_FOUND id not found
NULL_ARGUMENT id is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetIds
Description

Gets a list of the Ids assigned to an ontology.

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