org.osid.authentication

Interface AgentSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

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

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidSearchResults

getResultSize

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getAgents

AgentList getAgents()

Gets the agent list resulting from the search.

Returns:

the agent list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getAgentQueryInspector

AgentQueryInspector getAgentQueryInspector()

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

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getAgentSearchResultsRecord

AgentSearchResultsRecord getAgentSearchResultsRecord(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 results record

Throws:

NullArgumentException - agentSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(agentSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.