OSID Logo
OSID Specifications
authentication package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authentication.AgentSearchResults
Implementsosid.OsidSearchResults
Description

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

                     
                     
                     AgentSearch as = session.getAgentSearch();
                     as.limitResultSet(25, 50);
                     
                     AgentQuery queries[1];
                     queries[0] = session.getAgentQuery();
                     String kwords[1];
                     kwords[0] = "squid";
                     queries[0].matchKeywords(kwords);
                     
                     AgentSearchResults results = session.getAgentsBySearch(queries, as);
                     AgentList list = results.getAgents();
                     
                                 
                     
                
MethodgetAgents
Description

Gets the agent list resulting from the search.

Returnosid.authentication.AgentListthe agent list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetAgentQueryInspector
Description

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

Returnosid.authentication.AgentQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetAgentSearchResultsRecord
Description

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

Parametersosid.type.TypeagentSearchRecordTypean agent search record type
Returnosid.authentication.records.AgentSearchResultsRecordthe agent search results record
ErrorsNULL_ARGUMENT agentSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(agentSearchRecordType) is false
CompliancemandatoryThis method must be implemented.