Interface | osid.ontology.OntologyHierarchyDesignSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for managing a hierarchy of
| ||
Method | getOntologyHierarchyId | ||
Description |
Gets the hierarchy | ||
Return | osid.id.Id | the hierarchy Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getOntologyHierarchy | ||
Description |
Gets the hierarchy associated with this session. | ||
Return | osid.hierarchy.Hierarchy | the hierarchy associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canModifyOntologyHierarchy | ||
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 | ||
Return | boolean | false if changing this hierarchy is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | addRootOntology | ||
Description |
Adds a root ontology. | ||
Parameters | osid.id.Id | ontologyId | the Id of an ontology |
Errors | ALREADY_EXISTS | ontologyId is already in hierarchy | |
NOT_FOUND | ontologyId not found | ||
NULL_ARGUMENT | ontologyId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeRootOntology | ||
Description |
Removes a root ontology. | ||
Parameters | osid.id.Id | ontologyId | the Id of an ontology |
Errors | NOT_FOUND | ontologyId is not a root | |
NULL_ARGUMENT | ontologyId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | addChildOntology | ||
Description |
Adds a child to an ontology. | ||
Parameters | osid.id.Id | ontologyId | the Id of an ontology |
osid.id.Id | childId | the Id of the new child | |
Errors | ALREADY_EXISTS | ontologyId is already a parent of childId | |
NOT_FOUND | ontologyId or childId not found | ||
NULL_ARGUMENT | ontologyId or childId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeChildOntology | ||
Description |
Removes a child from an ontology. | ||
Parameters | osid.id.Id | ontologyId | the Id of an ontology |
osid.id.Id | childId | the Id of the new child | |
Errors | NOT_FOUND | ontologyId not a parent of childId | |
NULL_ARGUMENT | ontologyId or childId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeChildOntologies | ||
Description |
Removes all children from an ontology. | ||
Parameters | osid.id.Id | ontologyId | the Id of an ontology |
Errors | NOT_FOUND | ontologyId not in hierarchy | |
NULL_ARGUMENT | ontologyId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |