OSID Specifications
assessment package
Version 3.1.0
assessment package
Version 3.1.0
| Interface | osid.assessment.BankHierarchyDesignSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Used By | osid.assessment.AssessmentManager | ||
osid.assessment.AssessmentProxyManager | |||
| Description |
This session defines methods for managing a hierarchy of
| ||
| Method | getBankHierarchyId | ||
| Description |
Gets the hierarchy | ||
| Return | osid.id.Id | the hierarchy Id associated with this session | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBankHierarchy | ||
| 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 | assessment failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canModifyBankHierarchy | ||
| 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 | addRootBank | ||
| Description |
Adds a root bank. | ||
| Parameters | osid.id.Id | bankId | the Id of a bank |
| Errors | ALREADY_EXISTS | bankId is already in hierarchy | |
| NOT_FOUND | bankId not found | ||
| NULL_ARGUMENT | bankId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure occurred | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeRootBank | ||
| Description |
Removes a root bank from this hierarchy. | ||
| Parameters | osid.id.Id | bankId | the Id of a bank |
| Errors | NOT_FOUND | bankId not a parent of childId | |
| NULL_ARGUMENT | bankId or childId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | addChildBank | ||
| Description |
Adds a child to a bank. | ||
| Parameters | osid.id.Id | bankId | the Id of a bank |
osid.id.Id | childId | the Id of the new child | |
| Errors | ALREADY_EXISTS | bankId is already a parent of childId | |
| NOT_FOUND | bankId or childId not found | ||
| NULL_ARGUMENT | bankId or childId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure occurred | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeChildBank | ||
| Description |
Removes a child from a bank. | ||
| Parameters | osid.id.Id | bankId | the Id of a bank |
osid.id.Id | childId | the Id of the new child | |
| Errors | NOT_FOUND | bankId not parent of childId | |
| NULL_ARGUMENT | bankId or childId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure occurred | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeChildBanks | ||
| Description |
Removes all children from a bank. | ||
| Parameters | osid.id.Id | bankId | the Id of a bank |
| Errors | NOT_FOUND | bankId is not in hierarchy | |
| NULL_ARGUMENT | bankId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure occurred | ||
| Compliance | mandatory | This method must be implemented. | |