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

This session manages queries and sequencing to create "smart" dynamic catalogs. A FunctionQuery can be retrieved from this session and mapped to this Vault to create a virtual collection of Functions. The functions may be sequenced using the FunctionSearchOrder from this session.

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

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.
MethodgetFunctionQuery
Description

Gets a function query.

Returnosid.authorization.FunctionQuerythe function query
CompliancemandatoryThis method must be implemented.
MethodgetFunctionSearchOrder
Description

Gets a function search order.

Returnosid.authorization.FunctionSearchOrderthe function search order
CompliancemandatoryThis method must be implemented.
MethodapplyFunctionQuery
Description

Applies a function query to this vault.

Parametersosid.authorization.FunctionQueryfunctionQuerythe function query
ErrorsNULL_ARGUMENT functionQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED functionQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectFunctionQuery
Description

Gets a function query inspector for this vault.

Returnosid.authorization.FunctionQueryInspectorthe function query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyFunctionSequencing
Description

Applies a function search order to this vault.

Parametersosid.authorization.FunctionSearchOrderfunctionSearchOrderthe function search order
ErrorsNULL_ARGUMENT functionSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED functionSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetFunctionQueryFromInspector
Description

Gets a function query from an inspector.

Parametersosid.authorization.FunctionQueryInspectorfunctionQueryInspectora function query inspector
Returnosid.authorization.FunctionQuerythe function query
ErrorsNULL_ARGUMENT functionQueryInspector is null
UNSUPPORTED functionQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.