public interface ParameterProcessorSearchSession extends ParameterProcessorQuerySession
This session provides methods for searching among
ParameterProcessor
objects. The search query is constructed using
the ParameterProcessoryQuery.
getParameterProcessorsByQuery()
is the basic search
method and returns a list of ParameterProcessors.
A more
advanced search may be performed with
getParameterProcessorsBySearch().
It accepts a
ParameterProcessorSearch
in addition to the query for the purpose
of specifying additional options affecting the entire search, such as
configuration. getParameterProcessorsBySearch()
returns a
ParameterProcessorSearchResults
that can be used to access
the resulting ParameterProcessorList
or be used to perform
a search within the result set through ParameterProcessorSearch.
This session defines views that offer differing behaviors for searching.
ParameterProcessors
may have a query record indicated
by their respective record types. The query record is accessed via the
ParameterProcessorQuery.
Modifier and Type | Method and Description |
---|---|
ParameterProcessorQuery |
getParameterProcessorQueryFromInspector(ParameterProcessorQueryInspector parameterProcessorQueryInspector)
Gets a parameter processor query from an inspector.
|
ParameterProcessorSearchResults |
getParameterProcessorsBySearch(ParameterProcessorQuery parameterProcessorQuery,
ParameterProcessorSearch parameterProcessorSearch)
Gets the search results matching the given search query using the
given search.
|
ParameterProcessorSearch |
getParameterProcessorSearch()
Gets a parameter processor search.
|
ParameterProcessorSearchOrder |
getParameterProcessorSearchOrder()
Gets a parameter processor search order.
|
canSearchParameterProcessors, getConfiguration, getConfigurationId, getParameterProcessorQuery, getParameterProcessorsByQuery, useFederatedConfigurationView, useIsolatedConfigurationView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ParameterProcessorSearch getParameterProcessorSearch()
mandatory
- This method must be implemented. ParameterProcessorSearchOrder getParameterProcessorSearchOrder()
ParameterProcessorSearchOrder
is supplied to a
ParameterProcessorSearch
to specify the ordering of results.mandatory
- This method must be implemented. ParameterProcessorSearchResults getParameterProcessorsBySearch(ParameterProcessorQuery parameterProcessorQuery, ParameterProcessorSearch parameterProcessorSearch) throws OperationFailedException, PermissionDeniedException
parameterProcessorQuery
- the parameter processor queryparameterProcessorSearch
- the parameter processor searchNullArgumentException
- parameterProcessorQuery
or parameterProcessorSearch
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- parameterProcessorQuery
or parameterProcessorSearch
is not of
this servicemandatory
- This method must be implemented. ParameterProcessorQuery getParameterProcessorQueryFromInspector(ParameterProcessorQueryInspector parameterProcessorQueryInspector)
ParameterProcessorSearchResults.
parameterProcessorQueryInspector
- a parameter processor query
inspectorNullArgumentException
-
parameterProcessorQueryInspector
is null
UnsupportedException
-
parameterProcessorQueryInspector
is not of this
servicemandatory
- This method must be implemented.