public interface InputEnablerSearchSession extends InputEnablerQuerySession
This session provides methods for searching among InputEnabler
objects. The search query is constructed using the
InputEnableryQuery.
getInputEnablersByQuery()
is the basic search method
and returns a list of InputEnablers.
A more advanced search
may be performed with getInputEnablersBySearch().
It
accepts an InputEnablerSearch
in addition to the query for
the purpose of specifying additional options affecting the entire search,
such as offering. getInputEnablersBySearch()
returns an
InputEnablerSearchResults
that can be used to access the
resulting InputEnablerList
or be used to perform a search
within the result set through InputEnablerSearch.
This session defines views that offer differing behaviors for searching.
InputEnablers
may have a query record indicated by
their respective record types. The query record is accessed via the
InputEnablerQuery.
Modifier and Type | Method and Description |
---|---|
InputEnablerQuery |
getInputEnablerQueryFromInspector(InputEnablerQueryInspector inputEnablerQueryInspector)
Gets an input enabler query from an inspector.
|
InputEnablerSearchResults |
getInputEnablersBySearch(InputEnablerQuery inputEnablerQuery,
InputEnablerSearch inputEnablerSearch)
Gets the search results matching the given search query using the
given search.
|
InputEnablerSearch |
getInputEnablerSearch()
Gets an input enabler search.
|
InputEnablerSearchOrder |
getInputEnablerSearchOrder()
Gets an input enabler search order.
|
canSearchInputEnablers, getInputEnablerQuery, getInputEnablersByQuery, getSystem, getSystemId, useFederatedSystemView, useIsolatedSystemView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
InputEnablerSearch getInputEnablerSearch()
mandatory
- This method must be implemented. InputEnablerSearchOrder getInputEnablerSearchOrder()
InputEnablerSearchOrder
is supplied to an InputEnablerSearch
to specify
the ordering of results.mandatory
- This method must be implemented. InputEnablerSearchResults getInputEnablersBySearch(InputEnablerQuery inputEnablerQuery, InputEnablerSearch inputEnablerSearch) throws OperationFailedException, PermissionDeniedException
inputEnablerQuery
- the input enabler queryinputEnablerSearch
- the input enabler searchNullArgumentException
- inputEnablerQuery
or inputEnablerSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- inputEnablerQuery
or inputEnablerSearch
is not of this servicemandatory
- This method must be implemented. InputEnablerQuery getInputEnablerQueryFromInspector(InputEnablerQueryInspector inputEnablerQueryInspector)
InputEnablerSearchResults.
inputEnablerQueryInspector
- an input enabler query inspectorNullArgumentException
-
inputEnablerQueryInspector
is null
UnsupportedException
-
inputEnablerQueryInspector
is not of this servicemandatory
- This method must be implemented.