OSID Specifications
provisioning package
Version 3.1.0
provisioning package
Version 3.1.0
| Interface | osid.provisioning.DistributorHierarchyDesignSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Used By | osid.provisioning.ProvisioningManager | ||
osid.provisioning.ProvisioningProxyManager | |||
| Description |
This session defines methods for managing a hierarchy of
| ||
| Method | getDistributorHierarchyId | ||
| Description |
Gets the hierarchy | ||
| Return | osid.id.Id | the hierarchy Id associated with this session | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDistributorHierarchy | ||
| 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 | canModifyDistributorHierarchy | ||
| 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 | addRootDistributor | ||
| Description |
Adds a root distributor. | ||
| Parameters | osid.id.Id | distributorId | the Id of a distributor |
| Errors | ALREADY_EXISTS | distributorId is already in hierarchy | |
| NOT_FOUND | distributorId not found | ||
| NULL_ARGUMENT | distributorId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeRootDistributor | ||
| Description |
Removes a root distributor. | ||
| Parameters | osid.id.Id | distributorId | the Id of a distributor |
| Errors | NOT_FOUND | distributorId is not a root | |
| NULL_ARGUMENT | distributorId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | addChildDistributor | ||
| Description |
Adds a child to a distributor. | ||
| Parameters | osid.id.Id | distributorId | the Id of a distributor |
osid.id.Id | childId | the Id of the new child | |
| Errors | ALREADY_EXISTS | distributorId is already a parent of childId | |
| NOT_FOUND | distributorId or childId not found | ||
| NULL_ARGUMENT | distributorId or childId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeChildDistributor | ||
| Description |
Removes a child from a distributor. | ||
| Parameters | osid.id.Id | distributorId | the Id of a distributor |
osid.id.Id | childId | the Id of the new child | |
| Errors | NOT_FOUND | distributorId is not parent of childId | |
| NULL_ARGUMENT | distributorId or childId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeChildDistributors | ||
| Description |
Removes all children from a distributor. | ||
| Parameters | osid.id.Id | distributorId | the Id of a distributor |
| Errors | NOT_FOUND | distributorId is not found | |
| NULL_ARGUMENT | distributorId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |