public interface ParameterProcessorEnablerSearchSession extends ParameterProcessorEnablerQuerySession
This session provides methods for searching among
ParameterProcessorEnabler
objects. The search query is constructed
using the ParameterProcessorEnableryQuery.
getParameterProcessorEnablersByQuery()
is the basic
search method and returns a list of ParameterProcessorEnablers.
A more advanced search may be performed with
getParameterProcessorEnablersBySearch().
It accepts a
ParameterProcessorEnablerSearch
in addition to the query for the
purpose of specifying additional options affecting the entire search, such
as configuration. getParameterProcessorEnablersBySearch()
returns a ParameterProcessorEnablerSearchResults
that can
be used to access the resulting ParameterProcessorEnablerList
or be used to perform a search within the result set through
ParameterProcessorEnablerSearch.
This session defines views that offer differing behaviors for searching.
ParameterProcessorEnablers
may have a query record
indicated by their respective record types. The query record is accessed
via the ParameterProcessorEnablerQuery.
Modifier and Type | Method and Description |
---|---|
ParameterProcessorEnablerQuery |
getParameterProcessorEnablerQueryFromInspector(ParameterProcessorEnablerQueryInspector parameterProcessorEnablerQueryInspector)
Gets a parameter processor enabler query from an inspector.
|
ParameterProcessorEnablerSearchResults |
getParameterProcessorEnablersBySearch(ParameterProcessorEnablerQuery parameterProcessorEnablerQuery,
ParameterProcessorEnablerSearch parameterProcessorEnablerSearch)
Gets the search results matching the given search query using the
given search.
|
ParameterProcessorEnablerSearch |
getParameterProcessorEnablerSearch()
Gets a parameter processor enabler search.
|
ParameterProcessorEnablerSearchOrder |
getParameterProcessorEnablerSearchOrder()
Gets a parameter processor enabler search order.
|
canSearchParameterProcessorEnablers, getConfiguration, getConfigurationId, getParameterProcessorEnablerQuery, getParameterProcessorEnablersByQuery, useFederatedConfigurationView, useIsolatedConfigurationView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ParameterProcessorEnablerSearch getParameterProcessorEnablerSearch()
mandatory
- This method must be implemented. ParameterProcessorEnablerSearchOrder getParameterProcessorEnablerSearchOrder()
ParameterProcessorEnablerSearchOrder
is supplied to a
ParameterProcessorEnablerSearch
to specify the ordering of
results.mandatory
- This method must be implemented. ParameterProcessorEnablerSearchResults getParameterProcessorEnablersBySearch(ParameterProcessorEnablerQuery parameterProcessorEnablerQuery, ParameterProcessorEnablerSearch parameterProcessorEnablerSearch) throws OperationFailedException, PermissionDeniedException
parameterProcessorEnablerQuery
- the parameter processor enabler
queryparameterProcessorEnablerSearch
- the parameter processor
enabler searchNullArgumentException
-
parameterProcessorEnablerQuery
or
parameterProcessorEnablerSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
-
parameterProcessorEnablerQuery
or
parameterProcessorEnablerSearch
is not of this servicemandatory
- This method must be implemented. ParameterProcessorEnablerQuery getParameterProcessorEnablerQueryFromInspector(ParameterProcessorEnablerQueryInspector parameterProcessorEnablerQueryInspector)
ParameterProcessorEnablerSearchResults.
parameterProcessorEnablerQueryInspector
- a parameter processor
enabler query inspectorNullArgumentException
-
parameterProcessorEnablerQueryInspector
is null
UnsupportedException
-
parameterProcessorEnablerQueryInspector
is not of this
servicemandatory
- This method must be implemented.