OSID Logo
OSID Specifications
authentication package
Version 3.1.0
Interfaceosid.authentication.AgencyQuerySession
Implementsosid.OsidSession
Implemented Byosid.authentication.AgencySearchSession
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
Compliancemandatory This method must be implemented.
MethodgetAgencyQuery
Description

Gets an agency query.

Returnosid.authentication.AgencyQuery an agency query
Compliancemandatory This method must be implemented.
MethodgetAgenciesByQuery
Description

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

Parametersosid.authentication.AgencyQueryagencyQuery the agency query
Returnosid.authentication.AgencyList the returned AgencyList
ErrorsNULL_ARGUMENT agencyQuery is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED agencyQuery is not of this service
Compliancemandatory This method must be implemented.