Interface | osid.authentication.AgentSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
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 | searchAmongAgents | ||
Description |
Execute this search among the given list of agents. | ||
Parameters | osid.id.IdList | agentIds | list of agents |
Errors | NULL_ARGUMENT | agentIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderAgentResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.authentication.AgentSearchOrder | agentSearchOrder | agent search order |
Errors | NULL_ARGUMENT | agentSearchOrder is null | |
UNSUPPORTED | agentSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAgentSearchRecord | ||
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.AgentSearchRecord | the agent search 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. |