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.
Pools may have a query record indicated by their respective record
types. The query record is accessed via the PoolQuery.
Modifier and Type | Method and 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.
|
canSearchPools, getDistributor, getDistributorId, getPoolQuery, getPoolsByQuery, useFederatedDistributorView, useIsolatedDistributorView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
PoolSearch getPoolSearch()
mandatory
- This method must be implemented. PoolSearchOrder getPoolSearchOrder()
PoolSearchOrder
is
supplied to a PoolSearch
to specify the ordering of
results.mandatory
- This method must be implemented. PoolSearchResults getPoolsBySearch(PoolQuery poolQuery, PoolSearch poolSearch) throws OperationFailedException, PermissionDeniedException
poolQuery
- the pool querypoolSearch
- the pool searchNullArgumentException
- poolQuery
or
poolSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- poolQuery
or
poolSearch
is not of this servicemandatory
- This method must be implemented. PoolQuery getPoolQueryFromInspector(PoolQueryInspector poolQueryInspector)
PoolSearchResults.
poolQueryInspector
- a pool query inspectorNullArgumentException
- poolQueryInspector
is null
UnsupportedException
- poolQueryInspector
is not of this servicemandatory
- This method must be implemented.