OSID Logo
OSID Specifications
authentication keys package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authentication.keys.KeySmartAgencySession
Implementsosid.OsidSession
Description

This session manages queries and sequencing to create "smart" dynamic catalogs. An KeyQuery can be retrieved from this session and mapped to this Agency to create a virtual collection of Keys. The keys may be sequenced using the KeySearchOrder from this session.

This Agency has a default query that matches any key and a default search order that specifies no sequencing. The queries may be examined using an KeyQueryInspector. The query may be modified by converting the inspector back to an KeyQuery.

MethodgetAgencyId
Description

Gets the Agency Id associated with this session.

Returnosid.id.Idthe Agency Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetAgency
Description

Gets the Agency associated with this session.

Returnosid.authentication.Agencythe Agency associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageSmartAgencies
Description

Tests if this user can manage smart agencies. 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 agency management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetKeyQuery
Description

Gets an key query.

Returnosid.authentication.keys.KeyQuerythe key query
CompliancemandatoryThis method must be implemented.
MethodgetKeySearchOrder
Description

Gets an key search order.

Returnosid.authentication.keys.KeySearchOrderthe key search order
CompliancemandatoryThis method must be implemented.
MethodapplyKeyQuery
Description

Applies an key query to this agency.

Parametersosid.authentication.keys.KeyQuerykeyQuerythe key query
ErrorsNULL_ARGUMENT keyQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED keyQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectKeyQuery
Description

Gets an key query inspector for this agency.

Returnosid.authentication.keys.KeyQueryInspectorthe key query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyKeySequencing
Description

Applies an key search order to this agency.

Parametersosid.authentication.keys.KeySearchOrderkeySearchOrderthe key search order
ErrorsNULL_ARGUMENT keySearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED keySearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetKeyQueryFromInspector
Description

Gets an key query from an inspector.

Parametersosid.authentication.keys.KeyQueryInspectorkeyQueryInspectora query inspector
Returnosid.authentication.keys.KeyQuerythe key query
ErrorsNULL_ARGUMENT keyQueryInspector is null
UNSUPPORTED keyQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.