Interface AgentSearchSession

All Superinterfaces:

AgentQuerySession, AutoCloseable, Closeable, OsidSession, OsidSession

public interface AgentSearchSession
extends AgentQuerySession

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 Summary

Modifier and Type	Method	Description
AgentQuery	getAgentQueryFromInspector(AgentQueryInspector agentQueryInspector)	Gets an agent query from an inspector.
AgentSearchResults	getAgentsBySearch(AgentQuery agentQuery, AgentSearch agentSearch)	Gets the search results matching the given search query using the given search.
AgentSearch	getAgentSearch()	Gets an agent search.
AgentSearchOrder	getAgentSearchOrder()	Gets an agent search order.

Methods inherited from interface AgentQuerySession

canSearchAgents, getAgency, getAgencyId, getAgentQuery, getAgentsByQuery, useFederatedAgencyView, useIsolatedAgencyView

Modifier and Type	Method	Description
boolean	canSearchAgents()	Tests if this user can perform Agent searches.
Agency	getAgency()	Gets the Agency associated with this session.
Id	getAgencyId()	Gets the Agency Id associated with this session.
AgentQuery	getAgentQuery()	Gets an agent query.
AgentList	getAgentsByQuery(AgentQuery agentQuery)	Gets a list of Agents matching the given agent query.
void	useFederatedAgencyView()	Federates the view for methods in this session.
void	useIsolatedAgencyView()	Isolates the view for methods in this session.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getAgentSearch

AgentSearch getAgentSearch()

Gets an agent search.

Returns:

the agent search

Compliance:

mandatory - This method must be implemented.

getAgentSearchOrder

AgentSearchOrder getAgentSearchOrder()

Gets an agent search order. The AgentSearchOrder is supplied to an AgentSearch to specify the ordering of results.

Returns:

the agent search order

Compliance:

mandatory - This method must be implemented.

getAgentsBySearch

AgentSearchResults getAgentsBySearch(AgentQuery agentQuery,
 AgentSearch agentSearch)
                              throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

agentQuery - the agent query

agentSearch - the agent search

Returns:

the returned search results

Throws:

NullArgumentException - agentQuery or agentSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - agentSearch or agentQuery is not of this service

Compliance:

mandatory - This method must be implemented.

getAgentQueryFromInspector

AgentQuery getAgentQueryFromInspector(AgentQueryInspector agentQueryInspector)

Gets an agent query from an inspector. The inspector is available from an AgentSearchResults .

Parameters:

agentQueryInspector - an agent query inspector

Returns:

the agent query

Throws:

NullArgumentException - agentQueryInspector is null

UnsupportedException - agentQueryInspector is not of thiss ervice

Compliance:

mandatory - This method must be implemented.