public interface QualifierVaultSession extends OsidSession
This session provides methods to retrieve Qualifier
to
Vault
mappings. A Qualifier
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 |
canLookupQualifierVaultMappings()
Tests if this user can perform lookups of qualifier/vault mappings.
|
IdList |
getQualifierIdsByVault(Id vaultId)
Gets the list of
Qualifier Ids
associated with a Vault. |
IdList |
getQualifierIdsByVaults(IdList vaultIds)
Gets the list of
Qualifier Ids corresponding to a list
of Vaults. |
QualifierList |
getQualifiersByVault(Id vaultId)
Gets the list of
Qualifier associated with a
Vault. |
QualifierList |
getQualifiersByVaults(IdList vaultIds)
Gets the list of
Qualifiers corresponding to a list of
Vaults. |
IdList |
getVaultIdsByQualifier(Id qualifierId)
Gets the list of
Vault Ids mapped to a
Qualifier. |
VaultList |
getVaultsByQualifier(Id qualifierId)
Gets the list of
Vaults mapped to a Qualifier. |
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
Qualifier and Vault
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupQualifierVaultMappings()
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()
Qualifier
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 getQualifierIdsByVault(Id vaultId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Qualifier
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. QualifierList getQualifiersByVault(Id vaultId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Qualifier
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 getQualifierIdsByVaults(IdList vaultIds) throws OperationFailedException, PermissionDeniedException
Qualifier 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. QualifierList getQualifiersByVaults(IdList vaultIds) throws OperationFailedException, PermissionDeniedException
Qualifiers
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 getVaultIdsByQualifier(Id qualifierId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Vault
Ids
mapped to a
Qualifier.
qualifierId
- Id
of a Qualifier
Ids
NotFoundException
- qualifierId
is not
foundNullArgumentException
- qualifierId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. VaultList getVaultsByQualifier(Id qualifierId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Vaults
mapped to a Qualifier.
qualifierId
- Id
of a Qualifier
NotFoundException
- qualifierId
is not
foundNullArgumentException
- qualifierId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.