OSID Specifications
resource package
Version 3.0.0
Release Candidate Preview
resource package
Version 3.0.0
Release Candidate Preview
| Interface | osid.resource.BinHierarchyDesignSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session defines methods for managing a hierarchy of
| ||
| Method | getBinHierarchyId | ||
| Description |
Gets the hierarchy | ||
| Return | osid.id.Id | the hierarchy Id associated with this session | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBinHierarchy | ||
| 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 | canModifyBinHierarchy | ||
| 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 | addRootBin | ||
| Description |
Adds a root bin. | ||
| Parameters | osid.id.Id | binId | the Id of a bin |
| Errors | ALREADY_EXISTS | binId is already in hierarchy | |
| NOT_FOUND | binId not found | ||
| NULL_ARGUMENT | binId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeRootBin | ||
| Description |
Removes a root bin. | ||
| Parameters | osid.id.Id | binId | the Id of a bin |
| Errors | NOT_FOUND | binId not a root | |
| NULL_ARGUMENT | binId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | addChildBin | ||
| Description |
Adds a child to a bin. | ||
| Parameters | osid.id.Id | binId | the Id of a bin |
osid.id.Id | childId | the Id of the new child | |
| Errors | ALREADY_EXISTS | binId is already a parent of childId | |
| NOT_FOUND | binId or childId not found | ||
| NULL_ARGUMENT | binId or childId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeChildBin | ||
| Description |
Removes a child from a bin. | ||
| Parameters | osid.id.Id | binId | the Id of a bin |
osid.id.Id | childId | the Id of the new child | |
| Errors | NOT_FOUND | binId not a parent of childId | |
| NULL_ARGUMENT | binId or childId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeChildBins | ||
| Description |
Removes all children from a bin. | ||
| Parameters | osid.id.Id | binId | the Id of a bin |
| Errors | NOT_FOUND | binId not in hierarchy | |
| NULL_ARGUMENT | binId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |