| Interface | osid.authentication.AgentSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description | 
                 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 | getAgents | ||
| Description | 
                     Gets the agent list resulting from the search.  | ||
| Return | osid.authentication.AgentList | the agent list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAgentQueryInspector | ||
| Description | 
                     Gets the inspector for the query to examine the terms used in the search.  | ||
| Return | osid.authentication.AgentQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAgentSearchResultsRecord | ||
| Description | 
                     Gets the record corresponding to the given agent search 
                    record   | ||
| Parameters | osid.type.Type | agentSearchRecordType | an agent search record type | 
| Return | osid.authentication.records.AgentSearchResultsRecord | the agent search results record | |
| Errors | NULL_ARGUMENT |  agentSearchRecordType  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED |  hasRecordType(agentSearchRecordType)  is  false   |                 ||
| Compliance | mandatory | This method must be implemented. | |