Interface | osid.authorization.rules.AuthorizationEnablerVaultSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | canLookupAuthorizationEnablerVaultMappings | ||
Description |
Tests if this user can perform lookups of authorization
enabler/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 | useComparativeAuthorizationEnablerVaultView | ||
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 | usePlenaryAuthorizationEnablerVaultView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getAuthorizationEnablerIdsByVault | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | vaultId | Id of the Vault |
Return | osid.id.IdList | list of related authorization enabler 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 | getAuthorizationEnablersByVault | ||
Description |
Gets the list of authorization enablers associated with
a | ||
Parameters | osid.id.Id | vaultId | Id of the Vault |
Return | osid.authorization.rules.AuthorizationEnablerList | list of related authorization enablers | |
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 | getAuthorizationEnablerIdsByVaults | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | vaultIds | list of vault Ids |
Return | osid.id.IdList | list of authorization enabler 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 | getAuthorizationEnablersByVaults | ||
Description |
Gets the list of authorization enablers corresponding
to a list of | ||
Parameters | osid.id.IdList | vaultIds | list of vault Ids |
Return | osid.authorization.rules.AuthorizationEnablerList | list of authorization enablers | |
Errors | NULL_ARGUMENT | vaultIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getVaultIdsByAuthorizationEnabler | ||
Description |
Gets the | ||
Parameters | osid.id.Id | authorizationEnablerId | Id of an AuthorizationEnabler |
Return | osid.id.IdList | list of vaults | |
Errors | NOT_FOUND | authorizationEnablerId is not found | |
NULL_ARGUMENT | authorizationEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getVaultsByAuthorizationEnabler | ||
Description |
Gets the | ||
Parameters | osid.id.Id | authorizationEnablerId | Id of an AuthorizationEnabler |
Return | osid.authorization.VaultList | list of vaults | |
Errors | NOT_FOUND | authorizationEnablerId is not found | |
NULL_ARGUMENT | authorizationEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |