public interface AuthorizationEnablerVaultSession extends OsidSession
This session provides methods to retrieve AuthorizationEnabler
to Vault
mappings. An AuthorizationEnabler
may appear in multiple Vault
objects. Each vault
may have its own authorizations governing who is allowed to look at it.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupAuthorizationEnablerVaultMappings()
Tests if this user can perform lookups of authorization enabler/vault
mappings.
|
IdList |
getAuthorizationEnablerIdsByVault(Id vaultId)
Gets the list of
AuthorizationEnablerIds associated
with a Vault. |
IdList |
getAuthorizationEnablerIdsByVaults(IdList vaultIds)
Gets the list of
AuthorizationEnabler Ids corresponding
to a list of Vaults. |
AuthorizationEnablerList |
getAuthorizationEnablersByVault(Id vaultId)
Gets the list of authorization enablers associated with a
Vault. |
AuthorizationEnablerList |
getAuthorizationEnablersByVaults(IdList vaultIds)
Gets the list of authorization enablers corresponding to a list of
Vaults. |
IdList |
getVaultIdsByAuthorizationEnabler(Id authorizationEnablerId)
Gets the
Vault Ids mapped to an
AuthorizationEnabler. |
VaultList |
getVaultsByAuthorizationEnabler(Id authorizationEnablerId)
Gets the
Vaults mapped to an
AuthorizationEnabler. |
void |
useComparativeAuthorizationEnablerVaultView()
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 |
usePlenaryAuthorizationEnablerVaultView()
A complete view of the
AuthorizationEnabler and
Vault returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupAuthorizationEnablerVaultMappings()
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 useComparativeAuthorizationEnablerVaultView()
mandatory
- This method is must be implemented. void usePlenaryAuthorizationEnablerVaultView()
AuthorizationEnabler
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 getAuthorizationEnablerIdsByVault(Id vaultId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuthorizationEnablerIds
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. AuthorizationEnablerList getAuthorizationEnablersByVault(Id vaultId) throws NotFoundException, OperationFailedException, PermissionDeniedException
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 getAuthorizationEnablerIdsByVaults(IdList vaultIds) throws OperationFailedException, PermissionDeniedException
AuthorizationEnabler 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. AuthorizationEnablerList getAuthorizationEnablersByVaults(IdList vaultIds) throws OperationFailedException, PermissionDeniedException
Vaults.
vaultIds
- list of vault Ids
NullArgumentException
- vaultIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getVaultIdsByAuthorizationEnabler(Id authorizationEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Vault
Ids
mapped to an
AuthorizationEnabler.
authorizationEnablerId
- Id
of an
AuthorizationEnabler
NotFoundException
- authorizationEnablerId
is not foundNullArgumentException
- authorizationEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. VaultList getVaultsByAuthorizationEnabler(Id authorizationEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Vaults
mapped to an
AuthorizationEnabler.
authorizationEnablerId
- Id
of an
AuthorizationEnabler
NotFoundException
- authorizationEnablerId
is not foundNullArgumentException
- authorizationEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.