public interface AgentSearchResults extends OsidSearchResults
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();
Modifier and Type | Method and Description |
---|---|
AgentQueryInspector |
getAgentQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
AgentList |
getAgents()
Gets the agent list resulting from the search.
|
AgentSearchResultsRecord |
getAgentSearchResultsRecord(Type agentSearchRecordType)
Gets the record corresponding to the given agent search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
AgentList getAgents()
IllegalStateException
- list already retrievedmandatory
- This method must be implemented. AgentQueryInspector getAgentQueryInspector()
mandatory
- This method must be implemented. AgentSearchResultsRecord getAgentSearchResultsRecord(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.