public interface BrokerProcessorSearchSession extends BrokerProcessorQuerySession
This session provides methods for searching among
BrokerProcessor
objects. The search query is constructed using the
BrokerProcessoryQuery.
getBrokerProcessorsByQuery()
is the basic search method
and returns a list of BrokerProcessors.
A more advanced
search may be performed with getBrokerProcessorsBySearch().
It accepts a BrokerProcessorSearch
in addition to the query
for the purpose of specifying additional options affecting the entire
search, such as provisioning. getBrokerProcessorsBySearch()
returns a BrokerProcessorSearchResults
that can be used to
access the resulting BrokerProcessorList
or be used to
perform a search within the result set through
BrokerProcessorSearch.
This session defines views that offer differing behaviors for searching.
BrokerProcessors
may have a query record indicated by
their respective record types. The query record is accessed via the
BrokerProcessorQuery.
Modifier and Type | Method and Description |
---|---|
BrokerProcessorQuery |
getBrokerProcessorQueryFromInspector(BrokerProcessorQueryInspector brokerProcessorQueryInspector)
Gets a broker processor query from an inspector.
|
BrokerProcessorSearchResults |
getBrokerProcessorsBySearch(BrokerProcessorQuery brokerProcessorQuery,
BrokerProcessorSearch brokerProcessorSearch)
Gets the search results matching the given search query using the
given search.
|
BrokerProcessorSearch |
getBrokerProcessorSearch()
Gets a broker processor search.
|
BrokerProcessorSearchOrder |
getBrokerProcessorSearchOrder()
Gets a broker processor search order.
|
canSearchBrokerProcessors, getBrokerProcessorQuery, getBrokerProcessorsByQuery, getDistributor, getDistributorId, useFederatedDistributorView, useIsolatedDistributorView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
BrokerProcessorSearch getBrokerProcessorSearch()
mandatory
- This method must be implemented. BrokerProcessorSearchOrder getBrokerProcessorSearchOrder()
BrokerProcessorSearchOrder
is supplied to a
BrokerProcessorSearch
to specify the ordering of results.mandatory
- This method must be implemented. BrokerProcessorSearchResults getBrokerProcessorsBySearch(BrokerProcessorQuery brokerProcessorQuery, BrokerProcessorSearch brokerProcessorSearch) throws OperationFailedException, PermissionDeniedException
brokerProcessorQuery
- the broker processor querybrokerProcessorSearch
- the broker processor searchNullArgumentException
- brokerProcessorQuery
or brokerProcessorSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- brokerProcessorQuery
or brokerProcessorSearch
is not of this
servicemandatory
- This method must be implemented. BrokerProcessorQuery getBrokerProcessorQueryFromInspector(BrokerProcessorQueryInspector brokerProcessorQueryInspector)
BrokerProcessorSearchResults.
brokerProcessorQueryInspector
- a broker processor query
inspectorNullArgumentException
-
brokerProcessorQueryInspector
is null
UnsupportedException
-
brokerProcessorQueryInspector
is not of this servicemandatory
- This method must be implemented.