OSID Logo
OSID Specifications
authentication package
Version 3.1.0
Interfaceosid.authentication.AgencySearch
Implementsosid.OsidSearch
Used Byosid.authentication.AgencySearchSession
Description

The interface for governing agency searches.

MethodsearchAmongAgencies
Description

Execute this search among the given list of agencies.

Parametersosid.id.IdListagencyIds list of agencies
ErrorsNULL_ARGUMENT agencyIds is null
Compliancemandatory This method must be implemented.
MethodorderAgencyResults
Description

Specify an ordering to the search results.

Parametersosid.authentication.AgencySearchOrderagencySearchOrder agency search order
ErrorsNULL_ARGUMENT agencySearchOrder is null
UNSUPPORTED agencySearchOrder is not of this service
Compliancemandatory This 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.TypeagencySearchRecordType an agency search record type
Returnosid.authentication.records.AgencySearchRecord the agency search record
ErrorsNULL_ARGUMENT agencySearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(agencySearchRecordType) is false
Compliancemandatory This method must be implemented.