public interface PoolProcessorSearchSession extends PoolProcessorQuerySession
This session provides methods for searching among PoolProcessor
objects. The search query is constructed using the
PoolProcessoryQuery.
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 provisioning. 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 PoolProcessorSearch.
This session defines views that offer differing behaviors for searching.
PoolProcessors
may have a query record indicated by
their respective record types. The query record is accessed via the
PoolProcessorQuery.
Modifier and Type | Method and 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.
|
canSearchPoolProcessors, getDistributor, getDistributorId, getPoolProcessorQuery, getPoolProcessorsByQuery, useFederatedDistributorView, useIsolatedDistributorView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
PoolProcessorSearch getPoolProcessorSearch()
mandatory
- This method must be implemented. PoolProcessorSearchOrder getPoolProcessorSearchOrder()
PoolProcessorSearchOrder
is supplied to a
PoolProcessorSearch
to specify the ordering of results.mandatory
- This method must be implemented. PoolProcessorSearchResults getPoolProcessorsBySearch(PoolProcessorQuery poolProcessorQuery, PoolProcessorSearch poolProcessorSearch) throws OperationFailedException, PermissionDeniedException
poolProcessorQuery
- the pool processor querypoolProcessorSearch
- the pool processor searchNullArgumentException
- poolProcessorQuery
or poolProcessorSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- poolProcessorQuery
or poolProcessorSearch
is not of this
servicemandatory
- This method must be implemented. PoolProcessorQuery getPoolProcessorQueryFromInspector(PoolProcessorQueryInspector poolProcessorQueryInspector)
PoolProcessorSearchResults.
poolProcessorQueryInspector
- a pool processor query inspectorNullArgumentException
-
poolProcessorQueryInspector
is null
UnsupportedException
-
poolProcessorQueryInspector
is not of this servicemandatory
- This method must be implemented.