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

This session provides methods for searching Keys. The search query is constructed using the KeyQuery. The key record Type also specifies the record for the key query.

This session defines views that offer differing behaviors for searching.

  • federated agency view: searches include keys in agencies of which this agency is a ancestor in the agency hierarchy
  • isolated agency view: searches are restricted to agents in this agency

Keys may have a query record indicated by their respective record types. The query record is accessed via the 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.
MethodcanSearchKeys
Description

Tests if this user can perform Key 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.
MethoduseFederatedAgencyView
Description

Federates the view for methods in this session. A federated view will include keys in agencies which are children of this agency in the agency hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedAgencyView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this agency only.

CompliancemandatoryThis method is must be implemented.
MethodgetKeyQuery
Description

Gets a key query.

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

Gets a list of Keys matching the given search.

Parametersosid.authentication.keys.KeyQuerykeyQuerythe key query
Returnosid.authentication.keys.KeyListthe returned KeyList
ErrorsNULL_ARGUMENT keyQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED keyQuery is not of this service
CompliancemandatoryThis method must be implemented.