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

This session provides methods for searching among Agency objects. The search query is constructed using the AgencyQuery.

Agencies may have a query record indicated by their respective record types. The query record is accessed via the AgencyQuery.

MethodcanSearchAgencies
Description

Tests if this user can perform Agency 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 app

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAgencyQuery
Description

Gets an agency query.

Returnosid.authentication.AgencyQueryan agency query
CompliancemandatoryThis method must be implemented.
MethodgetAgenciesByQuery
Description

Gets a list of Agency objects matching the given agency query.

Parametersosid.authentication.AgencyQueryagencyQuerythe agency query
Returnosid.authentication.AgencyListthe returned AgencyList
ErrorsNULL_ARGUMENT agencyQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED agencyQuery is not of this service
CompliancemandatoryThis method must be implemented.