Interface | osid.authorization.AuthorizationVaultSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | useComparativeVaultView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryVaultView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | canLookupAuthorizationVaultMappings | ||
Description |
Tests if this user can perform lookups of
authorization/vault mappings. A return of true does not
guarantee successful authorization. A return of false
indicates that it is known lookup methods in this session
will result in a | ||
Return | boolean | false if looking up mappings is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAuthorizationIdsByVault | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | vaultId | Id of a Vault |
Return | osid.id.IdList | list of related authorization Ids | |
Errors | NOT_FOUND | vaultId is not found | |
NULL_ARGUMENT | vaultId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAuthorizationsByVault | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | vaultId | Id of a Vault |
Return | osid.authorization.AuthorizationList | list of related authorization | |
Errors | NOT_FOUND | vaultId is not found | |
NULL_ARGUMENT | vaultId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAuthorizationsIdsByVault | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | vaultIds | list of vault Ids |
Return | osid.id.IdList | list of authorization Ids | |
Errors | NULL_ARGUMENT | vaultIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAuthorizationsByVault | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | vaultIds | list of vault Ids |
Return | osid.authorization.AuthorizationList | list of authorizations | |
Errors | NULL_ARGUMENT | vaultIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getVaultIdsByAuthorization | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | authorizationId | Id of an Authorization |
Return | osid.id.IdList | list of vault Ids | |
Errors | NOT_FOUND | authorizationId is not found | |
NULL_ARGUMENT | authorizationId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getVaultByAuthorization | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | authorizationId | Id of an Authorization |
Return | osid.authorization.VaultList | list of vault | |
Errors | NOT_FOUND | authorizationId is not found | |
NULL_ARGUMENT | authorizationId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |