public interface BrokerProcessorEnablerSearchSession extends BrokerProcessorEnablerQuerySession
This session provides methods for searching among
BrokerProcessorEnabler
objects. The search query is constructed
using the BrokerProcessorEnableryQuery.
getBrokerProcessorEnablersByQuery()
is the basic search
method and returns a list of BrokerProcessorEnablers.
A
more advanced search may be performed with
getBrokerProcessorEnablersBySearch().
It accepts a
BrokerProcessorEnablerSearch
in addition to the query for the
purpose of specifying additional options affecting the entire search, such
as provisioning. getBrokerProcessorEnablersBySearch()
returns a BrokerProcessorEnablerSearchResults
that can be
used to access the resulting BrokerProcessorEnablerList
or
be used to perform a search within the result set through
BrokerProcessorEnablerSearch.
This session defines views that offer differing behaviors for searching.
BrokerProcessorEnablers
may have a query record
indicated by their respective record types. The query record is accessed
via the BrokerProcessorEnablerQuery.
Modifier and Type | Method and Description |
---|---|
BrokerProcessorEnablerQuery |
getBrokerProcessorEnablerQueryFromInspector(BrokerProcessorEnablerQueryInspector brokerProcessorEnablerQueryInspector)
Gets a broker processor enabler query from an inspector.
|
BrokerProcessorEnablerSearchResults |
getBrokerProcessorEnablersBySearch(BrokerProcessorEnablerQuery brokerProcessorEnablerQuery,
BrokerProcessorEnablerSearch brokerProcessorEnablerSearch)
Gets the search results matching the given search query using the
given search.
|
BrokerProcessorEnablerSearch |
getBrokerProcessorEnablerSearch()
Gets a broker processor enabler search.
|
BrokerProcessorEnablerSearchOrder |
getBrokerProcessorEnablerSearchOrder()
Gets a broker processor enabler search order.
|
canSearchBrokerProcessorEnablers, getBrokerProcessorEnablerQuery, getBrokerProcessorEnablersByQuery, getDistributor, getDistributorId, useFederatedDistributorView, useIsolatedDistributorView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
BrokerProcessorEnablerSearch getBrokerProcessorEnablerSearch()
mandatory
- This method must be implemented. BrokerProcessorEnablerSearchOrder getBrokerProcessorEnablerSearchOrder()
BrokerProcessorEnablerSearchOrder
is supplied to a
BrokerProcessorEnablerSearch
to specify the ordering of
results.mandatory
- This method must be implemented. BrokerProcessorEnablerSearchResults getBrokerProcessorEnablersBySearch(BrokerProcessorEnablerQuery brokerProcessorEnablerQuery, BrokerProcessorEnablerSearch brokerProcessorEnablerSearch) throws OperationFailedException, PermissionDeniedException
brokerProcessorEnablerQuery
- the broker processor enabler querybrokerProcessorEnablerSearch
- the broker processor enabler
searchNullArgumentException
-
brokerProcessorEnablerQuery
or
brokerProcessorEnablerSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
-
brokerProcessorEnablerQuery
or
brokerProcessorEnablerSearch
is not of this servicemandatory
- This method must be implemented. BrokerProcessorEnablerQuery getBrokerProcessorEnablerQueryFromInspector(BrokerProcessorEnablerQueryInspector brokerProcessorEnablerQueryInspector)
BrokerProcessorEnablerSearchResults.
brokerProcessorEnablerQueryInspector
- a broker processor
enabler query inspectorNullArgumentException
-
brokerProcessorEnablerQueryInspector
is null
UnsupportedException
-
brokerProcessorEnablerQueryInspector
is not of this
servicemandatory
- This method must be implemented.