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

AgentSearch defines the interface for specifying agent search options. This example gets a limited set of squid-like agents.

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

Execute this search among the given list of agents.

Parametersosid.id.IdListagentIdslist of agents
ErrorsNULL_ARGUMENT agentIds is null
CompliancemandatoryThis method must be implemented.
MethodorderAgentResults
Description

Specify an ordering to the search results.

Parametersosid.authentication.AgentSearchOrderagentSearchOrderagent search order
ErrorsNULL_ARGUMENT agentSearchOrder is null
UNSUPPORTED agentSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAgentSearchRecord
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.AgentSearchRecordthe agent search record
ErrorsNULL_ARGUMENT agentSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(agentSearchRecordType) is false
CompliancemandatoryThis method must be implemented.