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

This session manages queries and sequencing to create "smart" dynamic catalogs. A QualifierQuery can be retrieved from this session and mapped to this Vault to create a virtual collection of Qualifiers. The qualifiers may be sequenced using the QualifierSearchOrder from this session.

This Vault has a default query that matches any qualifier and a default search order that specifies no sequencing. The queries may be examined using a QualifierQueryInspector. The query may be modified by converting the inspector back to a QualifierQuery.

MethodgetVaultId
Description

Gets the Vault Id associated with this session.

Returnosid.id.Idthe Vault Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetVault
Description

Gets the Vault associated with this session.

Returnosid.authorization.Vaultthe Vault associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageSmartVaults
Description

Tests if this user can manage smart vaults. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.

Returnboolean false if smart vault management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetQualifierQuery
Description

Gets a qualifier query.

Returnosid.authorization.QualifierQuerythe qualifier query
CompliancemandatoryThis method must be implemented.
MethodgetQualifierSearchOrder
Description

Gets a qualifier search order.

Returnosid.authorization.QualifierSearchOrderthe qualifier search order
CompliancemandatoryThis method must be implemented.
MethodapplyQualifierQuery
Description

Applies a qualifier query to this vault.

Parametersosid.authorization.QualifierQueryqualifierQuerythe qualifier query
ErrorsNULL_ARGUMENT qualifierQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED qualifierQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectQualifierQuery
Description

Gets a qualifier query inspector for this vault.

Returnosid.authorization.QualifierQueryInspectorthe qualifier query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyQualifierSequencing
Description

Applies a qualifier search order to this vault.

Parametersosid.authorization.QualifierSearchOrderqualifierSearchOrderthe qualifier search order
ErrorsNULL_ARGUMENT qualifierSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED qualifierSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetQualifierQueryFromInspector
Description

Gets a qualifier query from an inspector.

Parametersosid.authorization.QualifierQueryInspectorqualifierQueryInspectora query inspector
Returnosid.authorization.QualifierQuerythe qualifier query
ErrorsNULL_ARGUMENT qualifierQueryInspector is null
UNSUPPORTED qualifierQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.