org.osid.authentication

Interface AgentSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface AgentSearch
extends OsidSearch

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();
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
AgentSearchRecord	getAgentSearchRecord(Type agentSearchRecordType) Gets the record corresponding to the given agent search record Type.
void	orderAgentResults(AgentSearchOrder agentSearchOrder) Specify an ordering to the search results.
void	searchAmongAgents(IdList agentIds) Execute this search among the given list of agents.

Methods inherited from interface org.osid.OsidSearch

limitResultSet

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Method Detail

searchAmongAgents

void searchAmongAgents(IdList agentIds)

Execute this search among the given list of agents.

Parameters:

agentIds - list of agents

Throws:

NullArgumentException - agentIds is null

Compliance:

mandatory - This method must be implemented.

orderAgentResults

void orderAgentResults(AgentSearchOrder agentSearchOrder)

Specify an ordering to the search results.

Parameters:

agentSearchOrder - agent search order

Throws:

NullArgumentException - agentSearchOrder is null

UnsupportedException - agentSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getAgentSearchRecord

AgentSearchRecord getAgentSearchRecord(Type agentSearchRecordType)
                                       throws OperationFailedException

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

Parameters:

agentSearchRecordType - an agent search record type

Returns:

the agent search record

Throws:

NullArgumentException - agentSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(agentSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.