Interface PoolProcessorSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, PoolProcessorQuerySession

public interface PoolProcessorSearchSession
extends PoolProcessorQuerySession

This session provides methods for searching among PoolProcessors . The search query is constructed using the PoolProcessorQuery .

getPoolProcessorsByQuery() is the basic search method and returns a list of PoolProcessors . A more advanced search may be performed with getPoolProcessorsBySearch() .It accepts a PoolProcessorSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getPoolProcessorsBySearch() returns a PoolProcessorSearchResults that can be used to access the resulting PoolProcessorList or be used to perform a search within the result set through Poo lProcessorSearch .

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Modifier and Type	Method	Description
PoolProcessorQuery	getPoolProcessorQueryFromInspector(PoolProcessorQueryInspector poolProcessorQueryInspector)	Gets a pool processor query from an inspector.
PoolProcessorSearchResults	getPoolProcessorsBySearch(PoolProcessorQuery poolProcessorQuery, PoolProcessorSearch poolProcessorSearch)	Gets the search results matching the given search query using the given search.
PoolProcessorSearch	getPoolProcessorSearch()	Gets a pool processor search.
PoolProcessorSearchOrder	getPoolProcessorSearchOrder()	Gets a pool processor 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 PoolProcessorQuerySession

canSearchPoolProcessors, getDistributor, getDistributorId, getPoolProcessorQuery, getPoolProcessorsByQuery, useFederatedDistributorView, useIsolatedDistributorView

Modifier and Type	Method	Description
boolean	canSearchPoolProcessors()	Tests if this user can perform PoolProcessor searches.
Distributor	getDistributor()	Gets the Distributor associated with this session.
Id	getDistributorId()	Gets the Distributor Id associated with this session.
PoolProcessorQuery	getPoolProcessorQuery()	Gets a pool processor query.
PoolProcessorList	getPoolProcessorsByQuery(PoolProcessorQuery poolProcessorQuery)	Gets a list of PoolProcessors 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

getPoolProcessorSearch

PoolProcessorSearch getPoolProcessorSearch()

Gets a pool processor search.

Returns:

the pool processor search

Compliance:

mandatory - This method must be implemented.

getPoolProcessorSearchOrder

PoolProcessorSearchOrder getPoolProcessorSearchOrder()

Gets a pool processor search order. The PoolProcessorSearchOrder is supplied to a PoolProcessorSearch to specify the ordering of results.

Returns:

the pool processor search order

Compliance:

mandatory - This method must be implemented.

getPoolProcessorsBySearch

PoolProcessorSearchResults getPoolProcessorsBySearch(PoolProcessorQuery poolProcessorQuery,
 PoolProcessorSearch poolProcessorSearch)
                                              throws OperationFailedException,
PermissionDeniedException

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

Parameters:

poolProcessorQuery - the pool processor query

poolProcessorSearch - the pool processor search

Returns:

the returned search results

Throws:

NullArgumentException - poolProcessorQuery or poolProcessorSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - poolProcessorQuery or poolProcessorSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getPoolProcessorQueryFromInspector

PoolProcessorQuery getPoolProcessorQueryFromInspector(PoolProcessorQueryInspector poolProcessorQueryInspector)

Gets a pool processor query from an inspector. The inspector is available from a PoolProcessorSearchResults .

Parameters:

poolProcessorQueryInspector - a pool processor query inspector

Returns:

the pool processor query

Throws:

NullArgumentException - poolProcessorQueryInspector is null

UnsupportedException - poolProcessorQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.