Interface PoolSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, PoolQuerySession

public interface PoolSearchSession
extends PoolQuerySession

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

getPoolsByQuery() is the basic search method and returns a list of Pools. A more advanced search may be performed with getPoolsBySearch(). It accepts a PoolSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getPoolsBySearch() returns a PoolSearchResults that can be used to access the resulting PoolList or be used to perform a search within the result set through PoolSearch.

This session defines views that offer differing behaviors for searching.

• federated broker view: searches include pools in brokers of which this broker is an ancestor in the broker hierarchy
• isolated broker view: searches are restricted to pools in this broker

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

Method Summary

Modifier and Type	Method	Description
PoolQuery	getPoolQueryFromInspector(PoolQueryInspector poolQueryInspector)	Gets a pool query from an inspector.
PoolSearchResults	getPoolsBySearch(PoolQuery poolQuery, PoolSearch poolSearch)	Gets the search results matching the given search query using the given search.
PoolSearch	getPoolSearch()	Gets a pool search.
PoolSearchOrder	getPoolSearchOrder()	Gets a pool search order.

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.

Methods inherited from interface PoolQuerySession

canSearchPools, getDistributor, getDistributorId, getPoolQuery, getPoolsByQuery, useFederatedDistributorView, useIsolatedDistributorView

Modifier and Type	Method	Description
boolean	canSearchPools()	Tests if this user can perform Pool lookups.
Distributor	getDistributor()	Gets the Distributor associated with this session.
Id	getDistributorId()	Gets the Distributor Id associated with this session.
PoolQuery	getPoolQuery()	Gets a pool query.
PoolList	getPoolsByQuery(PoolQuery poolQuery)	Gets a list of Pools matching the given pool query.
void	useFederatedDistributorView()	Federates the view for methods in this session.
void	useIsolatedDistributorView()	Isolates the view for methods in this session.

Method Details

getPoolSearch

PoolSearch getPoolSearch()

Gets a pool search.

Returns:

the pool search

Compliance:

mandatory - This method must be implemented.

getPoolSearchOrder

PoolSearchOrder getPoolSearchOrder()

Gets a pool search order. The PoolSearchOrder is supplied to a PoolSearch to specify the ordering of results.

Returns:

the pool search order

Compliance:

mandatory - This method must be implemented.

getPoolsBySearch

PoolSearchResults getPoolsBySearch(PoolQuery poolQuery,
 PoolSearch poolSearch)
                            throws OperationFailedException,
PermissionDeniedException

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

Parameters:

poolQuery - the pool query

poolSearch - the pool search

Returns:

the pool search results

Throws:

NullArgumentException - poolQuery or poolSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - poolQuery or poolSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getPoolQueryFromInspector

PoolQuery getPoolQueryFromInspector(PoolQueryInspector poolQueryInspector)

Gets a pool query from an inspector. The inspector is available from a PoolSearchResults.

Parameters:

poolQueryInspector - a pool query inspector

Returns:

the pool query

Throws:

NullArgumentException - poolQueryInspector is null

UnsupportedException - poolQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.