Interface AgencySearchSession

All Superinterfaces:

AgencyQuerySession, AutoCloseable, Closeable, OsidSession, OsidSession

public interface AgencySearchSession
extends AgencyQuerySession

This session provides methods for searching among Agency objects. The search query is constructed using the AgencyQuery.

getAgenciesByQuery() is the basic search method and returns a list of Agency objects.A more advanced search may be performed with getAgenciesBySearch().It accepts a AgencySearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getAgenciesBySearch() returns a AgencySearchResults that can be used to access the resulting AgencyList or be used to perform a search within the result set through AgencySearch.

Agencies may have a query record indicated by their respective record types. The query record is accessed via the AgencyQuery.

Method Summary

Modifier and Type	Method	Description
AgencySearchResults	getAgenciesBySearch(AgencyQuery agencyQuery, AgencySearch agencySearch)	Gets the search results matching the given search query using the given search.
AgencyQuery	getAgencyQueryFromInspector(AgencyQueryInspector agencyQueryInspector)	Gets an agency query from an inspector.
AgencySearch	getAgencySearch()	Gets an agency search.
AgencySearchOrder	getAgencySearchOrder()	Gets an agency search order.

Methods inherited from interface AgencyQuerySession

canSearchAgencies, getAgenciesByQuery, getAgencyQuery

Modifier and Type	Method	Description
boolean	canSearchAgencies()	Tests if this user can perform Agency searches.
AgencyList	getAgenciesByQuery(AgencyQuery agencyQuery)	Gets a list of Agency objects matching the given agency query.
AgencyQuery	getAgencyQuery()	Gets an agency query.

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

getAgencySearch

AgencySearch getAgencySearch()

Gets an agency search.

Returns:

an agency search

Compliance:

mandatory - This method must be implemented.

getAgencySearchOrder

AgencySearchOrder getAgencySearchOrder()

Gets an agency search order. The AgencySearchOrder is supplied to a AgencySearch to specify the ordering of results.

Returns:

the agency search order

Compliance:

mandatory - This method must be implemented.

getAgenciesBySearch

AgencySearchResults getAgenciesBySearch(AgencyQuery agencyQuery,
 AgencySearch agencySearch)
                                 throws OperationFailedException,
PermissionDeniedException

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

Parameters:

agencyQuery - the agency query

agencySearch - the agency search

Returns:

the search results

Throws:

NullArgumentException - agencyQuery or agencySearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - agencyQuery or agencySearch is not of this service

Compliance:

mandatory - This method must be implemented.

getAgencyQueryFromInspector

AgencyQuery getAgencyQueryFromInspector(AgencyQueryInspector agencyQueryInspector)

Gets an agency query from an inspector. The inspector is available from an AgencySearchResults.

Parameters:

agencyQueryInspector - an agency query inspector

Returns:

the agency query

Throws:

NullArgumentException - agencyQueryInspector is null

UnsupportedException - agencyQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.