Interface | osid.authorization.QualifierVaultAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Adding a reference of a | ||
Method | canAssignQualifiers | ||
Description |
Tests if this user can alter qualifier/vault mappings.
A return of true does not guarantee successful
authorization. A return of false indicates that it is
known mapping methods in this session will result in a
| ||
Return | boolean | false if mapping is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canAssignQualifiersToVault | ||
Description |
Tests if this user can alter qualifier/vault mappings.
A return of true does not guarantee successful
authorization. A return of false indicates that it is
known mapping methods in this session will result in a
| ||
Parameters | osid.id.Id | vaultId | the Id of the Vault |
Return | boolean | false if mapping is not authorized, true
otherwise | |
Errors | NULL_ARGUMENT | vaultId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableVaultIds | ||
Description |
Gets a list of vault including and under the given vault node in which any qualifier can be assigned. | ||
Parameters | osid.id.Id | vaultId | the Id of the Vault |
Return | osid.id.IdList | list of assignable vault Ids | |
Errors | NULL_ARGUMENT | vaultId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableVaultIdsForQualifier | ||
Description |
Gets a list of vault including and under the given vault node in which a specific qualifier can be assigned. | ||
Parameters | osid.id.Id | vaultId | the Id of the Vault |
osid.id.Id | qualifierId | the Id of the Qualifier | |
Return | osid.id.IdList | list of assignable vault Ids | |
Errors | NULL_ARGUMENT | vaultId or qualifierId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignQualifierToVault | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | qualifierId | the Id of the Qualifier |
osid.id.Id | vaultId | the Id of the Vault | |
Errors | ALREADY_EXISTS | qualifierId is already assigned to vaultId | |
NOT_FOUND | qualifierId or vaultId not found | ||
NULL_ARGUMENT | qualifierId or vaultId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignQualifierFromVault | ||
Description |
Removes a | ||
Parameters | osid.id.Id | qualifierId | the Id of the Qualifier |
osid.id.Id | vaultId | the Id of the Vault | |
Errors | NOT_FOUND | qualifierId or vaultId not found or
qualifierId not assigned to vaultId | |
NULL_ARGUMENT | qualifierId or vaultId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | reassignQualifierToVault | ||
Description |
Moves a | ||
Parameters | osid.id.Id | qualifierId | the Id of the Qualifier |
osid.id.Id | fromVaultId | the Id of the current Vault | |
osid.id.Id | toVaultId | the Id of the destination Vault | |
Errors | NOT_FOUND | qualfiierId, fromVaultId, or toVaultId not
found or qualfiierId, not mapped to fromVaultId | |
NULL_ARGUMENT | qualfiierId,, fromVaultId, or toVaultId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |