public interface AuthorizationVaultSession extends OsidSession
This session provides methods to retrieve Authorization
to Vault
mappings. An Authorization
may
appear in multiple Vaults.
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 |
canLookupAuthorizationVaultMappings()
Tests if this user can perform lookups of authorization/vault
mappings.
|
IdList |
getAuthorizationIdsByVault(Id vaultId)
Gets the list of
Authorization Ids
associated with a Vault. |
AuthorizationList |
getAuthorizationsByVault(Id vaultId)
Gets the list of
Authorizations associated with a
Vault. |
AuthorizationList |
getAuthorizationsByVault(IdList vaultIds)
Gets the list of
Authorizations corresponding to a list
of Vault. |
IdList |
getAuthorizationsIdsByVault(IdList vaultIds)
Gets the list of
Authorization Ids corresponding to a
list of Vault objects. |
VaultList |
getVaultByAuthorization(Id authorizationId)
Gets the list of
Vault objects mapped to an
Authorization. |
IdList |
getVaultIdsByAuthorization(Id authorizationId)
Gets the list of
Vault Ids mapped to an
Authorization. |
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
Authorization and Vault
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
void useComparativeVaultView()
mandatory
- This method is must be implemented. void usePlenaryVaultView()
Authorization
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. boolean canLookupAuthorizationVaultMappings()
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. IdList getAuthorizationIdsByVault(Id vaultId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Authorization
Ids
associated with a Vault.
vaultId
- Id
of a Vault
Ids
NotFoundException
- vaultId
is not foundNullArgumentException
- vaultId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuthorizationList getAuthorizationsByVault(Id vaultId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Authorizations
associated with a
Vault.
vaultId
- Id
of a Vault
NotFoundException
- vaultId
is not foundNullArgumentException
- vaultId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getAuthorizationsIdsByVault(IdList vaultIds) throws OperationFailedException, PermissionDeniedException
Authorization Ids
corresponding to a
list of Vault
objects.vaultIds
- list of vault Ids
Ids
NullArgumentException
- vaultIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AuthorizationList getAuthorizationsByVault(IdList vaultIds) throws OperationFailedException, PermissionDeniedException
Authorizations
corresponding to a list
of Vault.
vaultIds
- list of vault Ids
NullArgumentException
- vaultIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getVaultIdsByAuthorization(Id authorizationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Vault
Ids
mapped to an
Authorization.
authorizationId
- Id
of an Authorization
Ids
NotFoundException
- authorizationId
is
not foundNullArgumentException
- authorizationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. VaultList getVaultByAuthorization(Id authorizationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Vault
objects mapped to an
Authorization.
authorizationId
- Id
of an Authorization
NotFoundException
- authorizationId
is
not foundNullArgumentException
- authorizationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.