OSID - osid.authentication.AgentSearchSession Service Interface Definition

Interface	osid.authentication.AgentSearchSession
Implements	`osid.authentication.AgentQuerySession`
Used By	`osid.authentication.AuthenticationManager`
Used By	`osid.authentication.AuthenticationProxyManager`
Description	This session provides methods for searching `Agents`. The search query is constructed using the `AgentQuery`. The agent record `Type` also specifies the record for the agent query. `getAgentsByQuery()` is the basic search method and returns a list of `Agents`. A more advanced search may be performed with `getAgentsBySearch()`. It accepts an `AgentSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getAgentsBySearch()` returns an `AgentSearchResults` that can be used to access the resulting `AgentList` or be used to perform a search within the result set through `AgentSearch`. This session defines views that offer differing behaviors for searching. federated agency view: searches include agents in agencies of which this agency is a ancestor in the agency hierarchy isolated agency view: searches are restricted to agents in this agency Agents may have an agent query record indicated by their respective record types. The agent query record is accessed via the `AgentQuery`.
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 `AgentSearchOrder` is supplied to an `AgentSearch` to specify the ordering of results.
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
Parameters	`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 `AgentSearchResults`.
Parameters	`osid.authentication.AgentQueryInspector`	`agentQueryInspector`	an agent query inspector
Return	`osid.authentication.AgentQuery`		the agent query
Errors	NULL_ARGUMENT		`agentQueryInspector` is `null`
Errors	UNSUPPORTED		`agentQueryInspector` is not of thiss ervice
Compliance	`mandatory`		This method must be implemented.