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();
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.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongAgents(IdList agentIds)
agentIds
- list of agentsNullArgumentException
- agentIds
is
null
mandatory
- This method must be implemented. void orderAgentResults(AgentSearchOrder agentSearchOrder)
agentSearchOrder
- agent search orderNullArgumentException
- agentSearchOrder
is null
UnsupportedException
- agentSearchOrder
is not of this servicemandatory
- This method must be implemented. AgentSearchRecord getAgentSearchRecord(Type agentSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an object implementing
the requested record.agentSearchRecordType
- an agent search record typeNullArgumentException
- agentSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(agentSearchRecordType)
is false
mandatory
- This method must be implemented.