| Interface | osid.recognition.AcademyHierarchyDesignSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description | 
                 This session manages a hierarchy of academies. Academies 
                may be organized into a hierarchy for organizing or 
                federating. A parent   | ||
| Method | getAcademyHierarchyId | ||
| Description | 
                     Gets the hierarchy   | ||
| Return | osid.id.Id | the hierarchy  Id  associated with this session  | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAcademyHierarchy | ||
| 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 | canModifyAcademyHierarchy | ||
| 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 | addRootAcademy | ||
| Description | 
                     Adds a root academy.  | ||
| Parameters | osid.id.Id | academyId | the  Id  of an academy  | 
| Errors | ALREADY_EXISTS |  academyId  is already in hierarchy  |                 |
| NOT_FOUND |  academyId  is not found  |                 ||
| NULL_ARGUMENT |  academyId  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeRootAcademy | ||
| Description | 
                     Removes a root academy.  | ||
| Parameters | osid.id.Id | academyId | the  Id  of an academy  | 
| Errors | NOT_FOUND |  academyId  is not a root  |                 |
| NULL_ARGUMENT |  academyId  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | addChildAcademy | ||
| Description | 
                     Adds a child to an academy.  | ||
| Parameters | osid.id.Id | academyId | the  Id  of an academy  | 
osid.id.Id | childId | the  Id  of the new child  | |
| Errors | ALREADY_EXISTS |  academyId  is already a parent of  childId   |                 |
| NOT_FOUND |  academyId  or  childId  not found  |                 ||
| NULL_ARGUMENT |  academyId  or  childId  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeChildAcademy | ||
| Description | 
                     Removes a child from an academy.  | ||
| Parameters | osid.id.Id | academyId | the  Id  of an academy  | 
osid.id.Id | childId | the  Id  of the new child  | |
| Errors | NOT_FOUND |  academyId  not a parent of  childId   |                 |
| NULL_ARGUMENT |  academyId  or  childId  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeChildAcademies | ||
| Description | 
                     Removes all children from an academy.  | ||
| Parameters | osid.id.Id | academyId | the  Id  of an academy  | 
| Errors | NOT_FOUND |  academyId  not found  |                 |
| NULL_ARGUMENT |  academyId  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |