Interface VaultHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface VaultHierarchyDesignSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	addChildVault(Id vaultId, Id childId)	Adds a child to a vault.
void	addRootVault(Id vaultId)	Adds a root vault.
boolean	canModifyVaultHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getVaultHierarchy()	Gets the hierarchy associated with this session.
Id	getVaultHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildVault(Id vaultId, Id childId)	Removes a child from a vault.
void	removeChildVaults(Id vaultId)	Removes all children from a vault.
void	removeRootVault(Id vaultId)	Removes a root vault from this hierarchy.

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.

canModifyVaultHierarchy

boolean canModifyVaultHierarchy()

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.

Returns:

false if changing this hierarchy is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

addRootVault

void addRootVault(Id vaultId)
           throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root vault.

Parameters:

vaultId - the Id of a vault

Throws:

AlreadyExistsException - vaultId is already in hierarchy

NotFoundException - vaultId not found

NullArgumentException - vaultId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootVault

void removeRootVault(Id vaultId)
              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root vault from this hierarchy.

Parameters:

vaultId - the Id of a vault

Throws:

NotFoundException - vaultId not a parent of childId

NullArgumentException - vaultId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildVault

void addChildVault(Id vaultId,
 Id childId)
            throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to a vault.

Parameters:

vaultId - the Id of a vault

childId - the Id of the new child

Throws:

AlreadyExistsException - vaultId is already a parent of childId

NotFoundException - vaultId or childId not found

NullArgumentException - vaultId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildVault

void removeChildVault(Id vaultId,
 Id childId)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from a vault.

Parameters:

vaultId - the Id of a vault

childId - the Id of the child

Throws:

NotFoundException - vaultId not parent of childId

NullArgumentException - vaultId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildVaults

void removeChildVaults(Id vaultId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from a vault.

Parameters:

vaultId - the Id of a vault

Throws:

NotFoundException - vaultId is not in hierarchy

NullArgumentException - vaultId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.