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