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

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

getAgenciesByQuery() is the basic search method and returns a list of Agency objects.A more advanced search may be performed with getAgenciesBySearch(). It accepts a AgencySearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getAgenciesBySearch() returns a AgencySearchResults that can be used to access the resulting AgencyList or be used to perform a search within the result set through AgencySearch.

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

MethodgetAgencySearch
Description

Gets an agency search.

Returnosid.authentication.AgencySearchan agency search
CompliancemandatoryThis method must be implemented.
MethodgetAgencySearchOrder
Description

Gets an agency search order. The AgencySearchOrder is supplied to a AgencySearch to specify the ordering of results.

Returnosid.authentication.AgencySearchOrderthe agency search order
CompliancemandatoryThis method must be implemented.
MethodgetAgenciesBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.authentication.AgencyQueryagencyQuerythe agency query
osid.authentication.AgencySearchagencySearchthe agency search
Returnosid.authentication.AgencySearchResultsthe search results
ErrorsNULL_ARGUMENT agencyQuery or agencySearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED agencyQuery or agencySearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAgencyQueryFromInspector
Description

Gets an agency query from an inspector. The inspector is available from an AgencySearchResults.

Parametersosid.authentication.AgencyQueryInspectoragencyQueryInspectoran agency query inspector
Returnosid.authentication.AgencyQuerythe agency query
ErrorsNULL_ARGUMENT agencyQueryInspector is null
UNSUPPORTED agencyQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.