public interface BrokerConstrainerSearchSession extends BrokerConstrainerQuerySession
This session provides methods for searching among
BrokerConstrainer
objects. The search query is constructed using
the BrokerConstraineryQuery.
getBrokerConstrainersByQuery()
is the basic search
method and returns a list of BrokerConstrainers.
A more
advanced search may be performed with
getBrokerConstrainersBySearch().
It accepts a
BrokerConstrainerSearch
in addition to the query for the purpose
of specifying additional options affecting the entire search, such as
provisioning. getBrokerConstrainersBySearch()
returns a
BrokerConstrainerSearchResults
that can be used to access
the resulting BrokerConstrainerList
or be used to perform a
search within the result set through BrokerConstrainerSearch.
This session defines views that offer differing behaviors for searching.
BrokerConstrainers
may have a query record indicated by
their respective record types. The query record is accessed via the
BrokerConstrainerQuery.
Modifier and Type | Method and Description |
---|---|
BrokerConstrainerQuery |
getBrokerConstrainerQueryFromInspector(BrokerConstrainerQueryInspector brokerConstrainerQueryInspector)
Gets a broker constrainer query from an inspector.
|
BrokerConstrainerSearchResults |
getBrokerConstrainersBySearch(BrokerConstrainerQuery brokerConstrainerQuery,
BrokerConstrainerSearch brokerConstrainerSearch)
Gets the search results matching the given search query using the
given search.
|
BrokerConstrainerSearch |
getBrokerConstrainerSearch()
Gets a broker constrainer search.
|
BrokerConstrainerSearchOrder |
getBrokerConstrainerSearchOrder()
Gets a broker constrainer search order.
|
canSearchBrokerConstrainers, getBrokerConstrainerQuery, getBrokerConstrainersByQuery, getDistributor, getDistributorId, useFederatedDistributorView, useIsolatedDistributorView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
BrokerConstrainerSearch getBrokerConstrainerSearch()
mandatory
- This method must be implemented. BrokerConstrainerSearchOrder getBrokerConstrainerSearchOrder()
BrokerConstrainerSearchOrder
is supplied to a
BrokerConstrainerSearch
to specify the ordering of results.mandatory
- This method must be implemented. BrokerConstrainerSearchResults getBrokerConstrainersBySearch(BrokerConstrainerQuery brokerConstrainerQuery, BrokerConstrainerSearch brokerConstrainerSearch) throws OperationFailedException, PermissionDeniedException
brokerConstrainerQuery
- the broker constrainer querybrokerConstrainerSearch
- the broker constrainer searchNullArgumentException
- brokerConstrainerQuery
or brokerConstrainerSearch
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- brokerConstrainerQuery
or brokerConstrainerSearch
is not of
this servicemandatory
- This method must be implemented. BrokerConstrainerQuery getBrokerConstrainerQueryFromInspector(BrokerConstrainerQueryInspector brokerConstrainerQueryInspector)
BrokerConstrainerSearchResults.
brokerConstrainerQueryInspector
- a broker constrainer query
inspectorNullArgumentException
-
brokerConstrainerQueryInspector
is null
UnsupportedException
-
brokerConstrainerQueryInspector
is not of this servicemandatory
- This method must be implemented.