OSID Logo
OSID Specifications
authorization package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authorization.VaultHierarchyDesignSession
Implementsosid.OsidSession
Description

This session defines methods for managing a hierarchy of Vault objects. Each node in the hierarchy is a unique Vault.

MethodgetVaultHierarchyId
Description

Gets the hierarchy Id associated with this session.

Returnosid.id.Idthe hierarchy Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetVaultHierarchy
Description

Gets the hierarchy associated with this session.

Returnosid.hierarchy.Hierarchythe hierarchy associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanModifyVaultHierarchy
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 PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer these operations to an unauthorized user.

Returnboolean false if changing this hierarchy is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaddRootVault
Description

Adds a root vault.

Parametersosid.id.IdvaultIdthe Id of a vault
ErrorsALREADY_EXISTS vaultId is already in hierarchy
NOT_FOUND vaultId not found
NULL_ARGUMENT vaultId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveRootVault
Description

Removes a root vault from this hierarchy.

Parametersosid.id.IdvaultIdthe Id of a vault
ErrorsNOT_FOUND vaultId not a parent of childId
NULL_ARGUMENT vaultId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaddChildVault
Description

Adds a child to a vault.

Parametersosid.id.IdvaultIdthe Id of a vault
osid.id.IdchildIdthe Id of the new child
ErrorsALREADY_EXISTS vaultId is already a parent of childId
NOT_FOUND vaultId or childId not found
NULL_ARGUMENT vaultId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildVault
Description

Removes a child from a vault.

Parametersosid.id.IdvaultIdthe Id of a vault
osid.id.IdchildIdthe Id of the child
ErrorsNOT_FOUND vaultId not parent of childId
NULL_ARGUMENT vaultId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildVaults
Description

Removes all children from a vault.

Parametersosid.id.IdvaultIdthe Id of a vault
ErrorsNOT_FOUND vaultId is not in hierarchy
NULL_ARGUMENT vaultId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.