OSID Specifications
authorization package
Version 3.1.0
authorization package
Version 3.1.0
| Interface | osid.authorization.VaultHierarchyDesignSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Used By | osid.authorization.AuthorizationManager | ||
osid.authorization.AuthorizationProxyManager | |||
| Description |
This session defines methods for managing a hierarchy of
| ||
| Method | getVaultHierarchyId | ||
| Description |
Gets the hierarchy | ||
| Return | osid.id.Id | the hierarchy Id associated with this session | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getVaultHierarchy | ||
| 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 | canModifyVaultHierarchy | ||
| 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 | addRootVault | ||
| Description |
Adds a root vault. | ||
| Parameters | osid.id.Id | vaultId | the Id of a vault |
| Errors | ALREADY_EXISTS | vaultId is already in hierarchy | |
| NOT_FOUND | vaultId not found | ||
| NULL_ARGUMENT | vaultId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeRootVault | ||
| Description |
Removes a root vault from this hierarchy. | ||
| Parameters | osid.id.Id | vaultId | the Id of a vault |
| Errors | NOT_FOUND | vaultId not a parent of childId | |
| NULL_ARGUMENT | vaultId or childId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | addChildVault | ||
| Description |
Adds a child to a vault. | ||
| Parameters | osid.id.Id | vaultId | the Id of a vault |
osid.id.Id | childId | the Id of the new child | |
| Errors | ALREADY_EXISTS | vaultId is already a parent of childId | |
| NOT_FOUND | vaultId or childId not found | ||
| NULL_ARGUMENT | vaultId or childId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeChildVault | ||
| Description |
Removes a child from a vault. | ||
| Parameters | osid.id.Id | vaultId | the Id of a vault |
osid.id.Id | childId | the Id of the child | |
| Errors | NOT_FOUND | vaultId not parent of childId | |
| NULL_ARGUMENT | vaultId or childId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeChildVaults | ||
| Description |
Removes all children from a vault. | ||
| Parameters | osid.id.Id | vaultId | the Id of a vault |
| Errors | NOT_FOUND | vaultId is not in hierarchy | |
| NULL_ARGUMENT | vaultId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |