public interface BrokerSearchSession extends BrokerQuerySession
This session provides methods for searching among Broker
objects. The search query is constructed using the BrokerQuery.
getBrokersByQuery()
is the basic search method and
returns a list of Brokers.
A more advanced search may be
performed with getBrokersBySearch().
It accepts a
BrokerSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getBrokersBySearch()
returns a
BrokerSearchResults
that can be used to access the resulting
BrokerList
or be used to perform a search within the result
set through BrokerSearch.
This session defines views that offer differing behaviors for searching.
Brokers may have a query record indicated by their respective record
types. The query record is accessed via the BrokerQuery.
Modifier and Type | Method and Description |
---|---|
BrokerQuery |
getBrokerQueryFromInspector(BrokerQueryInspector brokerQueryInspector)
Gets a broker query from an inspector.
|
BrokerSearchResults |
getBrokersBySearch(BrokerQuery brokerQuery,
BrokerSearch brokerSearch)
Gets the search results matching the given search query using the
given search.
|
BrokerSearch |
getBrokerSearch()
Gets a broker search.
|
BrokerSearchOrder |
getBrokerSearchOrder()
Gets a broker search order.
|
canSearchBrokers, getBrokerQuery, getBrokersByQuery, getDistributor, getDistributorId, useFederatedDistributorView, useIsolatedDistributorView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
BrokerSearch getBrokerSearch()
mandatory
- This method must be implemented. BrokerSearchOrder getBrokerSearchOrder()
BrokerSearchOrder
is
supplied to a BrokerSearch
to specify the ordering of
results.mandatory
- This method must be implemented. BrokerSearchResults getBrokersBySearch(BrokerQuery brokerQuery, BrokerSearch brokerSearch) throws OperationFailedException, PermissionDeniedException
brokerQuery
- the broker querybrokerSearch
- the broker searchNullArgumentException
- brokerQuery
or
brokerSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- brokerQuery
or
brokerSearch
is not of this servicemandatory
- This method must be implemented. BrokerQuery getBrokerQueryFromInspector(BrokerQueryInspector brokerQueryInspector)
BrokerSearchResults.
brokerQueryInspector
- a broker query inspectorNullArgumentException
- brokerQueryInspector
is null
UnsupportedException
- brokerQueryInspector
is not of this servicemandatory
- This method must be implemented.