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

This session defines methods for traversing a hierarchy of Vault objects. Each node in the hierarchy is a unique Vault. The hierarchy may be traversed recursively to establish the tree structure through getParentVaults() and getChildVaults(). To relate these Ids to another OSID, getVaultNodes() can be used for retrievals that can be used for bulk lookups in other OSIDs. Any Vault available in the Authorization OSID is known to this hierarchy but does not appear in the hierarchy traversal until added as a root node or a child of another node.

A user may not be authorized to traverse the entire hierarchy. Parts of the hierarchy may be made invisible through omission from the returns of getParentVaults() or getChildVaults() in lieu of a PERMISSION_DENIED error that may disrupt the traversal through authorized pathways.

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: vault elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
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.
MethodcanAccessVaultHierarchy
Description

Tests if this user can perform hierarchy queries. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations.

Returnboolean false if hierarchy traversal methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeVaultView
Description

The returns from the vault methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryVaultView
Description

A complete view of the Hierarchy returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethodgetRootVaultIds
Description

Gets the root vault Ids in this hierarchy.

Returnosid.id.IdListthe root vault Ids
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRootVaults
Description

Gets the root vaults in this vault hierarchy.

Returnosid.authorization.VaultListthe root vaults
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodhasParentVaults
Description

Tests if the Vault has any parents.

Parametersosid.id.IdvaultIda vault Id
Returnboolean true if the vault has parents, false otherwise
ErrorsNOT_FOUND vaultId is not found
NULL_ARGUMENT vaultId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisParentOfVault
Description

Tests if an Id is a direct parent of a vault.

Parametersosid.id.Ididan Id
osid.id.IdvaultIdthe Id of a vault
Returnboolean true if this id is a parent of vaultId, false otherwise
ErrorsNOT_FOUND vaultId is not found
NULL_ARGUMENT id or vaultId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id not found return false.

MethodgetParentVaultIds
Description

Gets the parent Ids of the given vault.

Parametersosid.id.IdvaultIda vault Id
Returnosid.id.IdListthe parent Ids of the vault
ErrorsNOT_FOUND vaultId is not found
NULL_ARGUMENT vaultId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetParentVaults
Description

Gets the parents of the given vault.

Parametersosid.id.IdvaultIda vault Id
Returnosid.authorization.VaultListthe parents of the vault
ErrorsNOT_FOUND vaultId is not found
NULL_ARGUMENT vaultId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisAncestorOfVault
Description

Tests if an Id is an ancestor of a vault.

Parametersosid.id.Ididan Id
osid.id.IdvaultIdthe Id of a vault
Returnboolean true if this id is an ancestor of vaultId, false otherwise
ErrorsNOT_FOUND vaultId is not found
NULL_ARGUMENT vaultId or id is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id not found return false.

MethodhasChildVaults
Description

Tests if a vault has any children.

Parametersosid.id.IdvaultIda vaultId
Returnboolean true if the vaultId has children, false otherwise
ErrorsNOT_FOUND vaultId is not found
NULL_ARGUMENT vaultId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisChildOfVault
Description

Tests if a vault is a direct child of another.

Parametersosid.id.Ididan Id
osid.id.IdvaultIdthe Id of a vault
Returnboolean true if the id is a child of vaultId, false otherwise
ErrorsNOT_FOUND vaultId not found
NULL_ARGUMENT vaultId or id is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id not found return false.

MethodgetChildVaultIds
Description

Gets the child Ids of the given vault.

Parametersosid.id.IdvaultIdthe Id to query
Returnosid.id.IdListthe children of the vault
ErrorsNOT_FOUND vaultId is not found
NULL_ARGUMENT vaultId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetChildVaults
Description

Gets the children of the given vault.

Parametersosid.id.IdvaultIdthe Id to query
Returnosid.authorization.VaultListthe children of the vault
ErrorsNOT_FOUND vaultId is not found
NULL_ARGUMENT vaultId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisDescendantOfVault
Description

Tests if an Id is a descendant of a vault.

Parametersosid.id.Ididan Id
osid.id.IdvaultIdthe Id of a vault
Returnboolean true if the id is a descendant of the vaultId, false otherwise
ErrorsNOT_FOUND vaultId not found
NULL_ARGUMENT vaultId or id is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id is not found return false.

MethodgetVaultNodeIds
Description

Gets a portion of the hierarchy for the given vault.

Parametersosid.id.IdvaultIdthe Id to query
cardinalancestorLevelsthe maximum number of ancestor levels to include. A value of 0 returns no parents in the node.
cardinaldescendantLevelsthe maximum number of descendant levels to include. A value of 0 returns no children in the node.
booleanincludeSiblings true to include the siblings of the given node, false to omit the siblings
Returnosid.hierarchy.Nodea vault node
ErrorsNOT_FOUND vaultId is not found
NULL_ARGUMENT vaultId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetVaultNodes
Description

Gets a portion of the hierarchy for the given vault.

Parametersosid.id.IdvaultIdthe Id to query
cardinalancestorLevelsthe maximum number of ancestor levels to include. A value of 0 returns no parents in the node.
cardinaldescendantLevelsthe maximum number of descendant levels to include. A value of 0 returns no children in the node.
booleanincludeSiblings true to include the siblings of the given node, false to omit the siblings
Returnosid.authorization.VaultNodea vault node
ErrorsNOT_FOUND vaultId is not found
NULL_ARGUMENT vaultId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.