OSID Logo
OSID Specifications
authorization package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authorization.VaultLookupSession
Implementsosid.OsidSession
Description

This session provides methods for retrieving Vault objects. The Vault represents a collection of Functions and Authorizations.

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition

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 it can access, without breaking execution. However, an administrative application may require all Vault elements to be available.

Vaults may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the Vault.

MethodcanLookupVaults
Description

Tests if this user can perform Vault lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeVaultView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryVaultView
Description

A complete view of the Vault returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethodgetVault
Description

Gets the Vault specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Vault may have a different Id than requested, such as the case where a duplicate Id was assigned to a Vault and retained for compatibility.

Parametersosid.id.IdvaultId Id of the Vault
Returnosid.authorization.Vaultthe vault
ErrorsNOT_FOUND vaultId not found
NULL_ARGUMENT vaultId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetVaultsByIds
Description

Gets a VaultList corresponding to the given IdList. In plenary mode, the returned list contains all of the vaults specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Vault objects may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListvaultIdsthe list of Ids to retrieve
Returnosid.authorization.VaultListthe returned Vault list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT vaultIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetVaultsByGenusType
Description

Gets a VaultList corresponding to the given vault genus Type which does not include vaults of types derived from the specified Type. In plenary mode, the returned list contains all known vaults or an error results. Otherwise, the returned list may contain only those vaults that are accessible through this session.

Parametersosid.type.TypevaultGenusTypea vault genus type
Returnosid.authorization.VaultListthe returned Vault list
ErrorsNULL_ARGUMENT vaultGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetVaultsByParentGenusType
Description

Gets a VaultList corresponding to the given vault genus Type and include any additional vaults with genus types derived from the specified Type. In plenary mode, the returned list contains all known vaults or an error results. Otherwise, the returned list may contain only those vaults that are accessible through this session.

Parametersosid.type.TypevaultGenusTypea vault genus type
Returnosid.authorization.VaultListthe returned Vault list
ErrorsNULL_ARGUMENT vaultGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetVaultsByRecordType
Description

Gets a VaultList containing the given vault record Type. In plenary mode, the returned list contains all known vaults or an error results. Otherwise, the returned list may contain only those vaults that are accessible through this session.

Parametersosid.type.TypevaultRecordTypea vault record type
Returnosid.authorization.VaultListthe returned Vault list
ErrorsNULL_ARGUMENT vaultRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetVaultsByProvider
Description

Gets a VaultList from the given provider . In plenary mode, the returned list contains all known vaults or an error results. Otherwise, the returned list may contain only those vaults that are accessible through this session.

Parametersosid.id.IdresourceIda resource Id
Returnosid.authorization.VaultListthe returned Vault list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetVaults
Description

Gets all Vaults. In plenary mode, the returned list contains all known vaults or an error results. Otherwise, the returned list may contain only those vaults that are accessible through this session.

Returnosid.authorization.VaultLista VaultList
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.