public interface QualifierVaultAssignmentSession extends OsidSession
This session provides methods to re-assign Qualifiers
to
Vaults.
A Qualifier
may map to multiple
Vaults
and removing the last reference to a
Qualifier
is the equivalent of deleting it. Each Vault
may have its own authorizations governing who is allowed to
operate on it.
Adding a reference of a Qualifier
to another
Vault
is not a copy operation (eg: does not change its Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignQualifierToVault(Id qualifierId,
Id vaultId)
Adds an existing
Qualifier to a Vault. |
boolean |
canAssignQualifiers()
Tests if this user can alter qualifier/vault mappings.
|
boolean |
canAssignQualifiersToVault(Id vaultId)
Tests if this user can alter qualifier/vault mappings.
|
IdList |
getAssignableVaultIds(Id vaultId)
Gets a list of vault including and under the given vault node in which
any qualifier can be assigned.
|
IdList |
getAssignableVaultIdsForQualifier(Id vaultId,
Id qualifierId)
Gets a list of vault including and under the given vault node in which
a specific qualifier can be assigned.
|
void |
reassignQualifierToVault(Id qualifierId,
Id fromVaultId,
Id toVaultId)
Moves a
Qualifier from one Vault to
another. |
void |
unassignQualifierFromVault(Id qualifierId,
Id vaultId)
Removes a
Qualifier from a Vault. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignQualifiers()
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer assignment operations to
unauthorized users. false
if mapping is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canAssignQualifiersToVault(Id vaultId)
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer assignment operations to
unauthorized users.vaultId
- the Id
of the Vault
false
if mapping is not authorized, true
otherwiseNullArgumentException
- vaultId
is
null
mandatory
- This method must be implemented. IdList getAssignableVaultIds(Id vaultId) throws OperationFailedException
vaultId
- the Id
of the Vault
Ids
NullArgumentException
- vaultId
is
null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getAssignableVaultIdsForQualifier(Id vaultId, Id qualifierId) throws OperationFailedException
vaultId
- the Id
of the Vault
qualifierId
- the Id
of the Qualifier
Ids
NullArgumentException
- vaultId
or
qualifierId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignQualifierToVault(Id qualifierId, Id vaultId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Qualifier
to a Vault.
qualifierId
- the Id
of the Qualifier
vaultId
- the Id
of the Vault
AlreadyExistsException
- qualifierId
is
already assigned to vaultId
NotFoundException
- qualifierId
or
vaultId
not foundNullArgumentException
- qualifierId
or
vaultId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignQualifierFromVault(Id qualifierId, Id vaultId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Qualifier
from a Vault.
qualifierId
- the Id
of the Qualifier
vaultId
- the Id
of the Vault
NotFoundException
- qualifierId
or
vaultId
not found or qualifierId
not assigned to vaultId
NullArgumentException
- qualifierId
or
vaultId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void reassignQualifierToVault(Id qualifierId, Id fromVaultId, Id toVaultId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Qualifier
from one Vault
to
another. Mappings to other Vaults
are unaffected.qualifierId
- the Id
of the Qualifier
fromVaultId
- the Id
of the current Vault
toVaultId
- the Id
of the destination
Vault
NotFoundException
- qualfiierId, fromVaultId,
or toVaultId
not found or
qualfiierId,
not mapped to fromVaultId
NullArgumentException
- qualfiierId,,
fromVaultId,
or toVaultId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.