OSID Specifications
course package
Version 3.0.0
course package
Version 3.0.0
| Interface | osid.course.TermHierarchyDesignSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Used By | osid.course.CourseManager | ||
osid.course.CourseProxyManager | |||
| Description |
This session defines methods for managing a hierarchy of
| ||
| Method | getTermHierarchyId | ||
| Description |
Gets the hierarchy | ||
| Return | osid.id.Id | the hierarchy Id associated with this session | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTermHierarchy | ||
| 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 | canModifyTermHierarchy | ||
| 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 | addRootTerm | ||
| Description |
Adds a root term. | ||
| Parameters | osid.id.Id | termId | the Id of a term |
| Errors | ALREADY_EXISTS | termId is already in hierarchy | |
| NOT_FOUND | termId not found | ||
| NULL_ARGUMENT | termId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeRootTerm | ||
| Description |
Removes a root term. | ||
| Parameters | osid.id.Id | termId | the Id of a term |
| Errors | NOT_FOUND | termId not a root node | |
| NULL_ARGUMENT | termId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | addChildTerm | ||
| Description |
Adds a child to a term. | ||
| Parameters | osid.id.Id | termId | the Id of a term |
osid.id.Id | childId | the Id of the new child | |
| Errors | ALREADY_EXISTS | termId is already a parent of childId | |
| NOT_FOUND | termId or childId not found | ||
| NULL_ARGUMENT | termId or childId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeChildTerm | ||
| Description |
Removes a child from a term. | ||
| Parameters | osid.id.Id | termId | the Id of a term |
osid.id.Id | childId | the Id of the new child | |
| Errors | NOT_FOUND | termId not a parent of childId | |
| NULL_ARGUMENT | termId or childId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeChildTerms | ||
| Description |
Removes all children from a term. | ||
| Parameters | osid.id.Id | termId | the Id of a term |
| Errors | NOT_FOUND | termId is not in hierarchy | |
| NULL_ARGUMENT | termId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |