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.
Modifier and Type | Method and 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.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getVaultHierarchyId()
Id
associated with this session. Id
associated with this sessionmandatory
- This method must be implemented. Hierarchy getVaultHierarchy() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canModifyVaultHierarchy()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer these operations to an
unauthorized user. false
if changing this hierarchy is not
authorized, true
otherwisemandatory
- This method must be implemented. void addRootVault(Id vaultId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
vaultId
- the Id
of a vaultAlreadyExistsException
- vaultId
is
already in hierarchyNotFoundException
- vaultId
not foundNullArgumentException
- vaultId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeRootVault(Id vaultId) throws NotFoundException, OperationFailedException, PermissionDeniedException
vaultId
- the Id
of a vaultNotFoundException
- vaultId
not a parent
of childId
NullArgumentException
- vaultId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void addChildVault(Id vaultId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
vaultId
- the Id
of a vaultchildId
- the Id
of the new childAlreadyExistsException
- vaultId
is
already a parent of childId
NotFoundException
- vaultId
or
childId
not foundNullArgumentException
- vaultId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildVault(Id vaultId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException
vaultId
- the Id
of a vaultchildId
- the Id
of the childNotFoundException
- vaultId
not parent
of childId
NullArgumentException
- vaultId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildVaults(Id vaultId) throws NotFoundException, OperationFailedException, PermissionDeniedException
vaultId
- the Id
of a vaultNotFoundException
- vaultId
is not in
hierarchyNullArgumentException
- vaultId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.