OSID - osid.authorization.VaultHierarchySession Service Interface Definition

Interface	osid.authorization.VaultHierarchySession
Implements	`osid.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
Method	getVaultHierarchyId
Description	Gets the hierarchy `Id` associated with this session.
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
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canAccessVaultHierarchy
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.
Return	`boolean`		`false` if hierarchy traversal methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeVaultView
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.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryVaultView
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.
Compliance	`mandatory`		This method is must be implemented.
Method	getRootVaultIds
Description	Gets the root vault `Ids` in this hierarchy.
Return	`osid.id.IdList`		the root vault `Ids`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRootVaults
Description	Gets the root vaults in this vault hierarchy.
Return	`osid.authorization.VaultList`		the root vaults
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	hasParentVaults
Description	Tests if the `Vault` has any parents.
Parameters	`osid.id.Id`	`vaultId`	a vault `Id`
Return	`boolean`		`true` if the vault has parents, `false` otherwise
Errors	NOT_FOUND		`vaultId` is 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	isParentOfVault
Description	Tests if an `Id` is a direct parent of a vault.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`vaultId`	the `Id` of a vault
Return	`boolean`		`true` if this `id` is a parent of `vaultId,` `false` otherwise
Errors	NOT_FOUND		`vaultId` is not found
	NULL_ARGUMENT		`id` or `vaultId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If `id` not found return `false.`
Method	getParentVaultIds
Description	Gets the parent `Ids` of the given vault.
Parameters	`osid.id.Id`	`vaultId`	a vault `Id`
Return	`osid.id.IdList`		the parent `Ids` of the vault
Errors	NOT_FOUND		`vaultId` is 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	getParentVaults
Description	Gets the parents of the given vault.
Parameters	`osid.id.Id`	`vaultId`	a vault `Id`
Return	`osid.authorization.VaultList`		the parents of the vault
Errors	NOT_FOUND		`vaultId` is 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	isAncestorOfVault
Description	Tests if an `Id` is an ancestor of a vault.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`vaultId`	the `Id` of a vault
Return	`boolean`		`true` if this `id` is an ancestor of `vaultId,` `false` otherwise
Errors	NOT_FOUND		`vaultId` is not found
	NULL_ARGUMENT		`vaultId` or `id` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If `id` not found return `false.`
Method	hasChildVaults
Description	Tests if a vault has any children.
Parameters	`osid.id.Id`	`vaultId`	a `vaultId`
Return	`boolean`		`true` if the `vaultId` has children, `false` otherwise
Errors	NOT_FOUND		`vaultId` is 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	isChildOfVault
Description	Tests if a vault is a direct child of another.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`vaultId`	the `Id` of a vault
Return	`boolean`		`true` if the `id` is a child of `vaultId,` `false` otherwise
Errors	NOT_FOUND		`vaultId` not found
	NULL_ARGUMENT		`vaultId` or `id` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If `id` not found return `false.`
Method	getChildVaultIds
Description	Gets the child `Ids` of the given vault.
Parameters	`osid.id.Id`	`vaultId`	the `Id` to query
Return	`osid.id.IdList`		the children of the vault
Errors	NOT_FOUND		`vaultId` is 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	getChildVaults
Description	Gets the children of the given vault.
Parameters	`osid.id.Id`	`vaultId`	the `Id` to query
Return	`osid.authorization.VaultList`		the children of the vault
Errors	NOT_FOUND		`vaultId` is 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	isDescendantOfVault
Description	Tests if an `Id` is a descendant of a vault.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`vaultId`	the `Id` of a vault
Return	`boolean`		`true` if the `id` is a descendant of the `vaultId,` `false` otherwise
Errors	NOT_FOUND		`vaultId` not found
	NULL_ARGUMENT		`vaultId` or `id` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If `id` is not found return `false.`
Method	getVaultNodeIds
Description	Gets a portion of the hierarchy for the given vault.
Parameters	`osid.id.Id`	`vaultId`	the `Id` to query
	`cardinal`	`ancestorLevels`	the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.
	`cardinal`	`descendantLevels`	the maximum number of descendant levels to include. A value of 0 returns no children in the node.
	`boolean`	`includeSiblings`	`true` to include the siblings of the given node, `false` to omit the siblings
Return	`osid.hierarchy.Node`		a vault node
Errors	NOT_FOUND		`vaultId` is 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	getVaultNodes
Description	Gets a portion of the hierarchy for the given vault.
Parameters	`osid.id.Id`	`vaultId`	the `Id` to query
	`cardinal`	`ancestorLevels`	the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.
	`cardinal`	`descendantLevels`	the maximum number of descendant levels to include. A value of 0 returns no children in the node.
	`boolean`	`includeSiblings`	`true` to include the siblings of the given node, `false` to omit the siblings
Return	`osid.authorization.VaultNode`		a vault node
Errors	NOT_FOUND		`vaultId` is not found
	NULL_ARGUMENT		`vaultId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.