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

This session defines methods for managing a hierarchy of Ontology objects. Each node in the hierarchy is a unique Ontology.

MethodgetOntologyHierarchyId
Description

Gets the hierarchy Id associated with this session.

Returnosid.id.Idthe hierarchy Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetOntologyHierarchy
Description

Gets the hierarchy associated with this session.

Returnosid.hierarchy.Hierarchythe hierarchy associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanModifyOntologyHierarchy
Description

Tests if this user can change the hierarchy. A return of true does not guarantee successful authorization. A return of false indicates that it is known performing any update will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer these operations to an unauthorized user.

Returnboolean false if changing this hierarchy is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaddRootOntology
Description

Adds a root ontology.

Parametersosid.id.IdontologyIdthe Id of an ontology
ErrorsALREADY_EXISTS ontologyId is already in hierarchy
NOT_FOUND ontologyId not found
NULL_ARGUMENT ontologyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveRootOntology
Description

Removes a root ontology.

Parametersosid.id.IdontologyIdthe Id of an ontology
ErrorsNOT_FOUND ontologyId is not a root
NULL_ARGUMENT ontologyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaddChildOntology
Description

Adds a child to an ontology.

Parametersosid.id.IdontologyIdthe Id of an ontology
osid.id.IdchildIdthe Id of the new child
ErrorsALREADY_EXISTS ontologyId is already a parent of childId
NOT_FOUND ontologyId or childId not found
NULL_ARGUMENT ontologyId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildOntology
Description

Removes a child from an ontology.

Parametersosid.id.IdontologyIdthe Id of an ontology
osid.id.IdchildIdthe Id of the new child
ErrorsNOT_FOUND ontologyId not a parent of childId
NULL_ARGUMENT ontologyId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildOntologies
Description

Removes all children from an ontology.

Parametersosid.id.IdontologyIdthe Id of an ontology
ErrorsNOT_FOUND ontologyId not in hierarchy
NULL_ARGUMENT ontologyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.