OSID Logo
OSID Specifications
authentication package
Version 3.1.0
Interfaceosid.authentication.AgencySearchResults
Implementsosid.OsidSearchResults
Used Byosid.authentication.AgencySearchSession
Description

This interface provides a means to capture results of a search.

MethodgetAgencies
Description

Gets the agency list resultrng from a search.

Returnosid.authentication.AgencyList the agency list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetAgencyQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.authentication.AgencyQueryInspector the query inspector
Compliancemandatory This method must be implemented.
MethodgetAgencySearchResultsRecord
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.AgencySearchResultsRecord the agency search results record
ErrorsNULL_ARGUMENT agencySearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(agencySearchRecordType) is false
Compliancemandatory This method must be implemented.