Interface VaultHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface VaultHierarchySession
extends OsidSession

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 Summary

Modifier and Type	Method	Description
boolean	canAccessVaultHierarchy()	Tests if this user can perform hierarchy queries.
IdList	getChildVaultIds(Id vaultId)	Gets the child Ids of the given vault.
VaultList	getChildVaults(Id vaultId)	Gets the children of the given vault.
IdList	getParentVaultIds(Id vaultId)	Gets the parent Ids of the given vault.
VaultList	getParentVaults(Id vaultId)	Gets the parents of the given vault.
IdList	getRootVaultIds()	Gets the root vault Ids in this hierarchy.
VaultList	getRootVaults()	Gets the root vaults in this vault hierarchy.
Hierarchy	getVaultHierarchy()	Gets the hierarchy associated with this session.
Id	getVaultHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getVaultNodeIds(Id vaultId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given vault.
VaultNode	getVaultNodes(Id vaultId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given vault.
boolean	hasChildVaults(Id vaultId)	Tests if a vault has any children.
boolean	hasParentVaults(Id vaultId)	Tests if the Vault has any parents.
boolean	isAncestorOfVault(Id id, Id vaultId)	Tests if an Id is an ancestor of a vault.
boolean	isChildOfVault(Id id, Id vaultId)	Tests if a vault is a direct child of another.
boolean	isDescendantOfVault(Id id, Id vaultId)	Tests if an Id is a descendant of a vault.
boolean	isParentOfVault(Id id, Id vaultId)	Tests if an Id is a direct parent of a vault.
void	useComparativeVaultView()	The returns from the vault methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryVaultView()	A complete view of the Hierarchy returns is desired.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getVaultHierarchyId

Id getVaultHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getVaultHierarchy

Hierarchy getVaultHierarchy()
                     throws OperationFailedException,
PermissionDeniedException

Gets the hierarchy associated with this session.

Returns:

the hierarchy associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canAccessVaultHierarchy

boolean canAccessVaultHierarchy()

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.

Returns:

false if hierarchy traversal methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeVaultView

void useComparativeVaultView()

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.

usePlenaryVaultView

void usePlenaryVaultView()

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.

getRootVaultIds

IdList getRootVaultIds()
                throws OperationFailedException,
PermissionDeniedException

Gets the root vault Ids in this hierarchy.

Returns:

the root vault Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootVaults

VaultList getRootVaults()
                 throws OperationFailedException,
PermissionDeniedException

Gets the root vaults in this vault hierarchy.

Returns:

the root vaults

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentVaults

boolean hasParentVaults(Id vaultId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the Vault has any parents.

Parameters:

vaultId - a vault Id

Returns:

true if the vault has parents, false otherwise

Throws:

NotFoundException - vaultId is not found

NullArgumentException - vaultId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isParentOfVault

boolean isParentOfVault(Id id,
 Id vaultId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

id - an Id

vaultId - the Id of a vault

Returns:

true if this id is a parent of vaultId , false otherwise

Throws:

NotFoundException - vaultId is not found

NullArgumentException - id or vaultId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

getParentVaultIds

IdList getParentVaultIds(Id vaultId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given vault.

Parameters:

vaultId - a vault Id

Returns:

the parent Ids of the vault

Throws:

NotFoundException - vaultId is not found

NullArgumentException - vaultId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParentVaults

VaultList getParentVaults(Id vaultId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parents of the given vault.

Parameters:

vaultId - a vault Id

Returns:

the parents of the vault

Throws:

NotFoundException - vaultId is not found

NullArgumentException - vaultId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfVault

boolean isAncestorOfVault(Id id,
 Id vaultId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of a vault.

Parameters:

id - an Id

vaultId - the Id of a vault

Returns:

true if this id is an ancestor of vaultId , false otherwise

Throws:

NotFoundException - vaultId is not found

NullArgumentException - vaultId or id is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

hasChildVaults

boolean hasChildVaults(Id vaultId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a vault has any children.

Parameters:

vaultId - a vaultId

Returns:

true if the vaultId has children, false otherwise

Throws:

NotFoundException - vaultId is not found

NullArgumentException - vaultId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfVault

boolean isChildOfVault(Id id,
 Id vaultId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a vault is a direct child of another.

Parameters:

id - an Id

vaultId - the Id of a vault

Returns:

true if the id is a child of vaultId , false otherwise

Throws:

NotFoundException - vaultId not found

NullArgumentException - vaultId or id is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

getChildVaultIds

IdList getChildVaultIds(Id vaultId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given vault.

Parameters:

vaultId - the Id to query

Returns:

the children of the vault

Throws:

NotFoundException - vaultId is not found

NullArgumentException - vaultId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildVaults

VaultList getChildVaults(Id vaultId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the children of the given vault.

Parameters:

vaultId - the Id to query

Returns:

the children of the vault

Throws:

NotFoundException - vaultId is not found

NullArgumentException - vaultId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfVault

boolean isDescendantOfVault(Id id,
 Id vaultId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of a vault.

Parameters:

id - an Id

vaultId - the Id of a vault

Returns:

true if the id is a descendant of the vaultId , false otherwise

Throws:

NotFoundException - vaultId not found

NullArgumentException - vaultId or id is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} is not found return {@code false} .

getVaultNodeIds

Node getVaultNodeIds(Id vaultId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given vault.

Parameters:

vaultId - the Id to query

ancestorLevels - the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.

descendantLevels - the maximum number of descendant levels to include. A value of 0 returns no children in the node.

includeSiblings - true to include the siblings of the given node, false to omit the siblings

Returns:

a vault node

Throws:

NotFoundException - vaultId is not found

NullArgumentException - vaultId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getVaultNodes

VaultNode getVaultNodes(Id vaultId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given vault.

Parameters:

vaultId - the Id to query

ancestorLevels - the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.

descendantLevels - the maximum number of descendant levels to include. A value of 0 returns no children in the node.

includeSiblings - true to include the siblings of the given node, false to omit the siblings

Returns:

a vault node

Throws:

NotFoundException - vaultId is not found

NullArgumentException - vaultId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.