Interface | osid.authorization.VaultLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving This session defines views that offer differing behaviors when retrieving multiple objects.
Generally, the comparative view should be used for most
applications as it permits operation even if there is data
that cannot be accessed. For example, a browsing application
may only need to examine the Vaults may have an additional records indicated by their
respective record types. The record may not be accessed
through a cast of the | ||
Method | canLookupVaults | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
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 | getVault | ||
Description |
Gets the | ||
Parameters | osid.id.Id | vaultId | Id of the Vault |
Return | osid.authorization.Vault | the vault | |
Errors | NOT_FOUND | vaultId not found | |
NULL_ARGUMENT | vaultId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getVaultsByIds | ||
Description |
Gets a | ||
Parameters | osid.id.IdList | vaultIds | the list of Ids to retrieve |
Return | osid.authorization.VaultList | the returned Vault list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | vaultIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getVaultsByGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | vaultGenusType | a vault genus type |
Return | osid.authorization.VaultList | the returned Vault list | |
Errors | NULL_ARGUMENT | vaultGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getVaultsByParentGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | vaultGenusType | a vault genus type |
Return | osid.authorization.VaultList | the returned Vault list | |
Errors | NULL_ARGUMENT | vaultGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getVaultsByRecordType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | vaultRecordType | a vault record type |
Return | osid.authorization.VaultList | the returned Vault list | |
Errors | NULL_ARGUMENT | vaultRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getVaultsByProvider | ||
Description |
Gets a | ||
Parameters | osid.id.Id | resourceId | a resource Id |
Return | osid.authorization.VaultList | the returned Vault list | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getVaults | ||
Description |
Gets all | ||
Return | osid.authorization.VaultList | a VaultList | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |