OSID - osid.authentication.AgentQuerySession Service Interface Definition

Interface	osid.authentication.AgentQuerySession
Implements	`osid.OsidSession`
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. 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 agent record types. The agent query record is accessed via the `AgentQuery.`
Method	getAgencyId
Description	Gets the `Agency` `Id` associated with this session.
Return	`osid.id.Id`		the `Agency Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getAgency
Description	Gets the `Agency` associated with this session.
Return	`osid.authentication.Agency`		the `Agency` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchAgents
Description	Tests if this user can perform `Agent` searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer search operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedAgencyView
Description	Federates the view for methods in this session. A federated view will include agents in agencies which are children of this agency in the agency hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedAgencyView
Description	Isolates the view for methods in this session. An isolated view restricts searches to this agency only.
Compliance	`mandatory`		This method is must be implemented.
Method	getAgentQuery
Description	Gets an agent query.
Return	`osid.authentication.AgentQuery`		the agent query
Compliance	`mandatory`		This method must be implemented.
Method	getAgentsByQuery
Description	Gets a list of `Agents` matching the given agent query.
Parameters	`osid.authentication.AgentQuery`	`agentQuery`	the agent query
Return	`osid.authentication.AgentList`		the returned `AgentList`
Errors	NULL_ARGUMENT		`agentQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`agentQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.