Interface | osid.authentication.AgentSearchSession | ||
---|---|---|---|
Implements | osid.authentication.AgentQuerySession | ||
Description |
This session provides methods for searching This session defines views that offer differing behaviors for searching.
Agents may have an agent query record indicated by their
respective record types. The agent query record is accessed
via the | ||
Method | getAgentSearch | ||
Description |
Gets an agent search. | ||
Return | osid.authentication.AgentSearch | the agent search | |
Compliance | mandatory | This method must be implemented. | |
Method | getAgentSearchOrder | ||
Description |
Gets an agent search order. The | ||
Return | osid.authentication.AgentSearchOrder | the agent search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getAgentsBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.authentication.AgentQuery | agentQuery | the agent query |
osid.authentication.AgentSearch | agentSearch | the agent search | |
Return | osid.authentication.AgentSearchResults | the returned search results | |
Errors | NULL_ARGUMENT | agentQuery or agentSearch is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | agentSearch or agentQuery is not of this
service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAgentQueryFromInspector | ||
Description |
Gets an agent query from an inspector. The inspector is
available from an | ||
Parameters | osid.authentication.AgentQueryInspector | agentQueryInspector | an agent query inspector |
Return | osid.authentication.AgentQuery | the agent query | |
Errors | NULL_ARGUMENT | agentQueryInspector is null | |
UNSUPPORTED | agentQueryInspector is not of thiss ervice | ||
Compliance | mandatory | This method must be implemented. |