OSID Logo
OSID Specifications
authentication package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authentication.AgencySearch
Implementsosid.OsidSearch
Description

The interface for governing agency searches.

MethodsearchAmongAgencies
Description

Execute this search among the given list of agencies.

Parametersosid.id.IdListagencyIdslist of agencies
ErrorsNULL_ARGUMENT agencyIds is null
CompliancemandatoryThis method must be implemented.
MethodorderAgencyResults
Description

Specify an ordering to the search results.

Parametersosid.authentication.AgencySearchOrderagencySearchOrderagency search order
ErrorsNULL_ARGUMENT agencySearchOrder is null
UNSUPPORTED agencySearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAgencySearchRecord
Description

Gets the record corresponding to the given agency search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypeagencySearchRecordTypean agency search record type
Returnosid.authentication.records.AgencySearchRecordthe agency search record
ErrorsNULL_ARGUMENT agencySearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(agencySearchRecordType) is false
CompliancemandatoryThis method must be implemented.