Interface | osid.authorization.AuthorizationVaultAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Moving or adding a reference of a | ||
Method | canAssignAuthorizations | ||
Description |
Tests if this user can alter authorization/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 | canAssignAuthorizationsToVault | ||
Description |
Tests if this user can alter authorization/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 authorization 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 | getAssignableVaultIdsForAuthorization | ||
Description |
Gets a list of vault including and under the given vault node in which a specific authorization can be assigned. | ||
Parameters | osid.id.Id | vaultId | the Id of the Vault |
osid.id.Id | authorizationId | the Id of the Authorization | |
Return | osid.id.IdList | list of assignable vault Ids | |
Errors | NULL_ARGUMENT | vaultId or authorizationId is null
| |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignAuthorizationToVault | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | authorizationId | the Id of the Authorization |
osid.id.Id | vaultId | the Id of the Vault | |
Errors | ALREADY_EXISTS | authorizationId is already assigned to vaultId
| |
NOT_FOUND | authorizationId or vaultId not found | ||
NULL_ARGUMENT | authorizationId or vaultId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignAuthorizationFromVault | ||
Description |
Removes an | ||
Parameters | osid.id.Id | authorizationId | the Id of the Authorization |
osid.id.Id | vaultId | the Id of the Vault | |
Errors | NOT_FOUND | authorizationId or vaultId not found or
authorizationId not assigned to vaultId | |
NULL_ARGUMENT | authorizationId or vaultId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | reassignAuthorizationToVault | ||
Description |
Moves an | ||
Parameters | osid.id.Id | authorizationId | the Id of the Authorization |
osid.id.Id | fromVaultId | the Id of the current Vault | |
osid.id.Id | toVaultId | the Id of the destination Vault | |
Errors | NOT_FOUND | authorizationId, fromVaultId, or toVaultId
not found or authorizationId not mapped to fromVaultId
| |
NULL_ARGUMENT | authorizationId, fromVaultId, or toVaultId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |