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

This session manages queries and sequencing to create "smart" dynamic catalogs. A AuthorizationQuery can be retrieved from this session and mapped to this Vault to create a virtual collection of Authorizations. The authorizations may be sequenced using the AuthorizationSearchOrder from this session.

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

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

Tests if this user can manage smart vault. 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.
MethodgetAuthorizationQuery
Description

Gets a authorization query.

Returnosid.authorization.AuthorizationQuerythe authorization query
CompliancemandatoryThis method must be implemented.
MethodgetAuthorizationSearchOrder
Description

Gets a authorization search order.

Returnosid.authorization.AuthorizationSearchOrderthe authorization search order.
CompliancemandatoryThis method must be implemented.
MethodapplyAuthorizationQuery
Description

Applies a authorization query to this vault.

Parametersosid.authorization.AuthorizationQueryauthorizationQuerythe authorization query
ErrorsNULL_ARGUMENT authorizationQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED authorizationQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectAuthorizationQuery
Description

Gets a authorization query inspector for this vault.

Returnosid.authorization.AuthorizationQueryInspectorthe authorization query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyAuthorizationSequencing
Description

Applies a authorization search order to this vault.

Parametersosid.authorization.AuthorizationSearchOrderauthorizationSearchOrderthe authorization search order
ErrorsNULL_ARGUMENT authorizationSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED authorizationSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAuthorizationQueryFromInspector
Description

Gets a authorization query from an inspector.

Parametersosid.authorization.AuthorizationQueryInspectorauthorizationQueryInspectora resorce relationship query inspector
Returnosid.authorization.AuthorizationQuerythe authorization query
ErrorsNULL_ARGUMENT authorizationQueryInspector is null
UNSUPPORTED authorizationQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.