public interface PoolProcessorEnablerSearchSession extends PoolProcessorEnablerQuerySession
This session provides methods for searching among
PoolProcessorEnabler
objects. The search query is constructed
using the PoolProcessorEnableryQuery.
getPoolProcessorEnablersByQuery()
is the basic search
method and returns a list of PoolProcessorEnablers.
A more
advanced search may be performed with
getPoolProcessorEnablersBySearch().
It accepts a
PoolProcessorEnablerSearch
in addition to the query for the
purpose of specifying additional options affecting the entire search, such
as provisioning. getPoolProcessorEnablersBySearch()
returns
a PoolProcessorEnablerSearchResults
that can be used to
access the resulting PoolProcessorEnablerList
or be used to
perform a search within the result set through
PoolProcessorEnablerSearch.
This session defines views that offer differing behaviors for searching.
PoolProcessorEnablers
may have a query record indicated
by their respective record types. The query record is accessed via the
PoolProcessorEnablerQuery.
Modifier and Type | Method and Description |
---|---|
PoolProcessorEnablerQuery |
getPoolProcessorEnablerQueryFromInspector(PoolProcessorEnablerQueryInspector poolProcessorEnablerQueryInspector)
Gets a pool processor enabler query from an inspector.
|
PoolProcessorEnablerSearchResults |
getPoolProcessorEnablersBySearch(PoolProcessorEnablerQuery poolProcessorEnablerQuery,
PoolProcessorEnablerSearch poolProcessorEnablerSearch)
Gets the search results matching the given search query using the
given search.
|
PoolProcessorEnablerSearch |
getPoolProcessorEnablerSearch()
Gets a pool processor enabler search.
|
PoolProcessorEnablerSearchOrder |
getPoolProcessorEnablerSearchOrder()
Gets a pool processor enabler search order.
|
canSearchPoolProcessorEnablers, getDistributor, getDistributorId, getPoolProcessorEnablerQuery, getPoolProcessorEnablersByQuery, useFederatedDistributorView, useIsolatedDistributorView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
PoolProcessorEnablerSearch getPoolProcessorEnablerSearch()
mandatory
- This method must be implemented. PoolProcessorEnablerSearchOrder getPoolProcessorEnablerSearchOrder()
PoolProcessorEnablerSearchOrder
is supplied to a
PoolProcessorEnablerSearch
to specify the ordering of results.mandatory
- This method must be implemented. PoolProcessorEnablerSearchResults getPoolProcessorEnablersBySearch(PoolProcessorEnablerQuery poolProcessorEnablerQuery, PoolProcessorEnablerSearch poolProcessorEnablerSearch) throws OperationFailedException, PermissionDeniedException
poolProcessorEnablerQuery
- the pool processor enabler querypoolProcessorEnablerSearch
- the pool processor enabler searchNullArgumentException
-
poolProcessorEnablerQuery
or
poolProcessorEnablerSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- poolProcessorEnablerQuery
or poolProcessorEnablerSearch
is not of
this servicemandatory
- This method must be implemented. PoolProcessorEnablerQuery getPoolProcessorEnablerQueryFromInspector(PoolProcessorEnablerQueryInspector poolProcessorEnablerQueryInspector)
PoolProcessorEnablerSearchResults.
poolProcessorEnablerQueryInspector
- a pool processor enabler
query inspectorNullArgumentException
-
poolProcessorEnablerQueryInspector
is null
UnsupportedException
-
poolProcessorEnablerQueryInspector
is not of this
servicemandatory
- This method must be implemented.