Interface PoolEnablerSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, PoolEnablerQuerySession

public interface PoolEnablerSearchSession
extends PoolEnablerQuerySession

This session provides methods for searching among PoolEnablers . The search query is constructed using the PoolEnablerQuery .

getPoolEnablersByQuery() is the basic search method and returns a list of PoolEnablers . A more advanced search may be performed with getPoolEnablersBySearch() .It accepts a PoolEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getPoolEnablersBySearch() returns a PoolEnablerSearchResults that can be used to access the resulting PoolEnablerList or be used to perform a search within the result set through Poo lEnablerSearch .

This session defines views that offer differing behaviors for searching.

• federated distributor view: searches include pool enablers in distributors of which this distributor is an ancestor in the distributor hierarchy
• isolated distributor view: searches are restricted to pool enablers in this distributor

Pool enablers may have a query record indicated by their respective record types. The query record is accessed via the PoolEnablerQuery .

Method Summary

Modifier and Type	Method	Description
PoolEnablerQuery	getPoolEnablerQueryFromInspector(PoolEnablerQueryInspector poolEnablerQueryInspector)	Gets a pool enabler query from an inspector.
PoolEnablerSearchResults	getPoolEnablersBySearch(PoolEnablerQuery poolEnablerQuery, PoolEnablerSearch poolEnablerSearch)	Gets the search results matching the given search query using the given search.
PoolEnablerSearch	getPoolEnablerSearch()	Gets a pool enabler search.
PoolEnablerSearchOrder	getPoolEnablerSearchOrder()	Gets a pool enabler 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 PoolEnablerQuerySession

canSearchPoolEnablers, getDistributor, getDistributorId, getPoolEnablerQuery, getPoolEnablersByQuery, useFederatedDistributorView, useIsolatedDistributorView

Modifier and Type	Method	Description
boolean	canSearchPoolEnablers()	Tests if this user can perform PoolEnabler searches.
Distributor	getDistributor()	Gets the Distributor associated with this session.
Id	getDistributorId()	Gets the Distributor Id associated with this session.
PoolEnablerQuery	getPoolEnablerQuery()	Gets a pool enabler query.
PoolEnablerList	getPoolEnablersByQuery(PoolEnablerQuery poolEnablerQuery)	Gets a list of PoolEnablers matching the given search.
void	useFederatedDistributorView()	Federates the view for methods in this session.
void	useIsolatedDistributorView()	Isolates the view for methods in this session.

Method Details

getPoolEnablerSearch

PoolEnablerSearch getPoolEnablerSearch()

Gets a pool enabler search.

Returns:

the pool enabler search

Compliance:

mandatory - This method must be implemented.

getPoolEnablerSearchOrder

PoolEnablerSearchOrder getPoolEnablerSearchOrder()

Gets a pool enabler search order. The PoolEnablerSearchOrder is supplied to a PoolEnablerSearch to specify the ordering of results.

Returns:

the pool enabler search order

Compliance:

mandatory - This method must be implemented.

getPoolEnablersBySearch

PoolEnablerSearchResults getPoolEnablersBySearch(PoolEnablerQuery poolEnablerQuery,
 PoolEnablerSearch poolEnablerSearch)
                                          throws OperationFailedException,
PermissionDeniedException

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

Parameters:

poolEnablerQuery - the pool enabler query

poolEnablerSearch - the pool enabler search

Returns:

the returned search results

Throws:

NullArgumentException - poolEnablerQuery or poolEnablerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - poolEnablerQuery or poolEnablerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getPoolEnablerQueryFromInspector

PoolEnablerQuery getPoolEnablerQueryFromInspector(PoolEnablerQueryInspector poolEnablerQueryInspector)

Gets a pool enabler query from an inspector. The inspector is available from a PoolEnablerSearchResults .

Parameters:

poolEnablerQueryInspector - a pool enabler query inspector

Returns:

the pool enabler query

Throws:

NullArgumentException - poolEnablerQueryInspector is null

UnsupportedException - poolEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.