public interface BrokerConstrainerEnablerSearchSession extends BrokerConstrainerEnablerQuerySession
This session provides methods for searching among
BrokerConstrainerEnabler
objects. The search query is constructed
using the BrokerConstrainerEnableryQuery.
getBrokerConstrainerEnablersByQuery()
is the basic
search method and returns a list of BrokerConstrainerEnablers.
A more advanced search may be performed with
getBrokerConstrainerEnablersBySearch().
It accepts a
BrokerConstrainerEnablerSearch
in addition to the query for the
purpose of specifying additional options affecting the entire search, such
as provisioning. getBrokerConstrainerEnablersBySearch()
returns a BrokerConstrainerEnablerSearchResults
that can be
used to access the resulting BrokerConstrainerEnablerList
or be used to perform a search within the result set through
BrokerConstrainerEnablerSearch.
This session defines views that offer differing behaviors for searching.
BrokerConstrainerEnablers
may have a query record
indicated by their respective record types. The query record is accessed
via the BrokerConstrainerEnablerQuery.
Modifier and Type | Method and Description |
---|---|
BrokerConstrainerEnablerQuery |
getBrokerConstrainerEnablerQueryFromInspector(BrokerConstrainerEnablerQueryInspector brokerConstrainerEnablerQueryInspector)
Gets a broker constrainer enabler query from an inspector.
|
BrokerConstrainerEnablerSearchResults |
getBrokerConstrainerEnablersBySearch(BrokerConstrainerEnablerQuery brokerConstrainerEnablerQuery,
BrokerConstrainerEnablerSearch brokerConstrainerEnablerSearch)
Gets the search results matching the given search query using the
given search.
|
BrokerConstrainerEnablerSearch |
getBrokerConstrainerEnablerSearch()
Gets a broker constrainer enabler search.
|
BrokerConstrainerEnablerSearchOrder |
getBrokerConstrainerEnablerSearchOrder()
Gets a broker constrainer enabler search order.
|
canSearchBrokerConstrainerEnablers, getBrokerConstrainerEnablerQuery, getBrokerConstrainerEnablersByQuery, getDistributor, getDistributorId, useFederatedDistributorView, useIsolatedDistributorView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
BrokerConstrainerEnablerSearch getBrokerConstrainerEnablerSearch()
mandatory
- This method must be implemented. BrokerConstrainerEnablerSearchOrder getBrokerConstrainerEnablerSearchOrder()
BrokerConstrainerEnablerSearchOrder
is supplied to a
BrokerConstrainerEnablerSearch
to specify the ordering of
results.mandatory
- This method must be implemented. BrokerConstrainerEnablerSearchResults getBrokerConstrainerEnablersBySearch(BrokerConstrainerEnablerQuery brokerConstrainerEnablerQuery, BrokerConstrainerEnablerSearch brokerConstrainerEnablerSearch) throws OperationFailedException, PermissionDeniedException
brokerConstrainerEnablerQuery
- the broker constrainer enabler
querybrokerConstrainerEnablerSearch
- the broker constrainer enabler
searchNullArgumentException
-
brokerConstrainerEnablerQuery
or
brokerConstrainerEnablerSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
-
brokerConstrainerEnablerQuery
or
brokerConstrainerEnablerSearch
is not of this servicemandatory
- This method must be implemented. BrokerConstrainerEnablerQuery getBrokerConstrainerEnablerQueryFromInspector(BrokerConstrainerEnablerQueryInspector brokerConstrainerEnablerQueryInspector)
BrokerConstrainerEnablerSearchResults.
brokerConstrainerEnablerQueryInspector
- a broker constrainer
enabler query inspectorNullArgumentException
-
brokerConstrainerEnablerQueryInspector
is null
UnsupportedException
-
brokerConstrainerEnablerQueryInspector
is not of this
servicemandatory
- This method must be implemented.