public interface FunctionVaultSession extends OsidSession
This session provides methods to retrieve Function
to
Vault
mappings. A Function
may appear in
multiple Vaults.
Each Vault
may have its own
authorizations governing who is allowed to look at it.
This lookup session defines two views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupFunctionVaultMappings()
Tests if this user can perform lookups of function/vault mappings.
|
IdList |
getFunctionIdsByVault(Id vaultId)
Gets the list of
Function Ids associated
with a Vault. |
IdList |
getFunctionIdsByVaults(IdList vaultIds)
Gets the list of
Function Ids corresponding to a list
of Vaults. |
FunctionList |
getFunctionsByVault(Id vaultId)
Gets the list of
Functions associated with a
Vault. |
FunctionList |
getFunctionsByVaults(IdList vaultIds)
Gets the list of
Functions corresponding to a list of
Vaults. |
IdList |
getVaultIdsByFunction(Id functionId)
Gets the list of
Vault Ids mapped to a
Function. |
VaultList |
getVaultsByFunction(Id functionId)
Gets the list of
Vaults mapped to a Function. |
void |
useComparativeVaultView()
The returns from the lookup 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
Function and Vault
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupFunctionVaultMappings()
PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer lookup operations
to unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeVaultView()
mandatory
- This method is must be implemented. void usePlenaryVaultView()
Function
and Vault
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.mandatory
- This method is must be implemented. IdList getFunctionIdsByVault(Id vaultId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Function
Ids
associated
with a Vault.
vaultId
- Id
of the Vault
Ids
NotFoundException
- vaultId
is not foundNullArgumentException
- vaultId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. FunctionList getFunctionsByVault(Id vaultId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Functions
associated with a
Vault.
vaultId
- Id
of the Vault
NotFoundException
- vaultId
is not foundNullArgumentException
- vaultId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getFunctionIdsByVaults(IdList vaultIds) throws OperationFailedException, PermissionDeniedException
Function Ids
corresponding to a list
of Vaults.
vaultIds
- list of vault Ids
Ids
NullArgumentException
- vaultIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. FunctionList getFunctionsByVaults(IdList vaultIds) throws OperationFailedException, PermissionDeniedException
Functions
corresponding to a list of
Vaults.
vaultIds
- list of vault Ids
NullArgumentException
- vaultIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getVaultIdsByFunction(Id functionId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Vault
Ids
mapped to a
Function.
functionId
- Id
of a Function
Ids
NotFoundException
- functionId
is not
foundNullArgumentException
- functionId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. VaultList getVaultsByFunction(Id functionId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Vaults
mapped to a Function.
functionId
- Id
of a Function
NotFoundException
- functionId
is not
foundNullArgumentException
- functionId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.