public interface ConfigurationSearchSession extends ConfigurationQuerySession
This session provides methods for searching among Configuration
objects. The search query is constructed using the
ConfigurationQuery.
getConfigurationsByQuery()
is the basic search method
and returns a list of Configuration
objects.A more advanced
search may be performed with getConfigurationsBySearch().
It accepts a ConfigurationSearch
in addition to the query
for the purpose of specifying additional options affecting the entire
search, such as ordering. getConfigurationsBySearch()
returns a ConfigurationSearchResults
that can be used to
access the resulting ConfigurationList
or be used to
perform a search within the result set through ConfigurationSearch.
Configurations may have a query record indicated by their respective
record types. The query record is accessed via the
ConfigurationQuery.
The returns in this session may not be cast
directly to these interfaces.
Modifier and Type | Method and Description |
---|---|
ConfigurationQuery |
getConfigurationQueryFromInspector(ConfigurationQueryInspector configurationQueryInspector)
Gets a configuration query from an inspector.
|
ConfigurationSearchResults |
getConfigurationsBySearch(ConfigurationQuery configurationQuery,
ConfigurationSearch configurationSearch)
Gets a list of
Configurations matching the given
search. |
ConfigurationSearch |
getConfigurationSearch()
Gets a configuration search.
|
ConfigurationSearchOrder |
getConfigurationSearchOrder()
Gets a log search order.
|
canSearchConfigurations, getConfigurationQuery, getConfigurationsByQuery
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ConfigurationSearch getConfigurationSearch()
mandatory
- This method must be implemented. ConfigurationSearchOrder getConfigurationSearchOrder()
ConfigurationSearchOrder
is supplied to a ConfigurationSearch
to specify the
ordering of results.mandatory
- This method must be implemented. ConfigurationSearchResults getConfigurationsBySearch(ConfigurationQuery configurationQuery, ConfigurationSearch configurationSearch) throws OperationFailedException, PermissionDeniedException
Configurations
matching the given
search. Each element in the array is OR'd.configurationQuery
- the configuration queryconfigurationSearch
- the configuration searchNullArgumentException
- configurationQuery
or configurationSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- configurationQuery
or configurationSearch
is not of this
servicemandatory
- This method must be implemented. ConfigurationQuery getConfigurationQueryFromInspector(ConfigurationQueryInspector configurationQueryInspector)
ConfigurationSearchResults.
configurationQueryInspector
- a configuration query inspectorNullArgumentException
-
configurationQueryInspector
is null
UnsupportedException
-
configurationQueryInspector
is not of this servicemandatory
- This method must be implemented.