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

This session provides methods for searching among Vault objects. The search query is constructed using the VaultQuery.

Vaults may have a query record indicated by their respective record types. The query record is accessed via the VaultQuery.

MethodcanSearchVaults
Description

Tests if this user can perform Vault searches. 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 search operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetVaultQuery
Description

Gets a vault query.

Returnosid.authorization.VaultQuerya vault query
CompliancemandatoryThis method must be implemented.
MethodgetVaultsByQuery
Description

Gets a list of Vault objects matching the given search.

Parametersosid.authorization.VaultQueryvaultQuerythe vault query
Returnosid.authorization.VaultListthe returned VaultList
ErrorsNULL_ARGUMENT vaultQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED vaultQuery is not of this service
CompliancemandatoryThis method must be implemented.