public interface ValueSearchSession extends ValueQuerySession
This session provides methods for searching Value
objects. The search query is constructed using the ValueQuery.
The parameter Type
also specifies the record for
the value query.
getValuesByQuery()
is the basic search method and
returns a list of Values.
A more advanced search may be
performed with getValuesBySearch().
It accepts a
ValueSearch
in addition to the query for the purpose of specifying
additional options affecting the entire search, such as ordering.
getValuesBySearch()
returns a ValueSearchResults
that can be used to access the resulting ValueList
or be
used to perform a search within the result set through ValueSearch.
Two views of the configuration data are defined;
Modifier and Type | Method and Description |
---|---|
ValueQuery |
getValueQueryFromInspector(ValueQueryInspector valueQueryInspector)
Gets a value query from an inspector.
|
ValueSearchResults |
getValuesBySearch(ValueQuery valueQuery,
ValueSearch valueSearch)
Gets a list of
Values matching the given search query
using the given search. |
ValueSearch |
getValueSearch()
Gets a value search.
|
ValueSearchOrder |
getValueSearchOrder()
Gets a value search order.
|
canSearchValues, getConfiguration, getConfigurationId, getValueQuery, getValuesByQuery, useFederatedConfigurationView, useIsolatedConfigurationView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ValueSearch getValueSearch()
mandatory
- This method must be implemented. ValueSearchOrder getValueSearchOrder()
ValueSearchOrder
is
supplied to a ValueSearch
to specify the ordering of
results.mandatory
- This method must be implemented. ValueSearchResults getValuesBySearch(ValueQuery valueQuery, ValueSearch valueSearch) throws OperationFailedException, PermissionDeniedException
Values
matching the given search query
using the given search.valueQuery
- the value queryvalueSearch
- the value searchNullArgumentException
- valueQuery
or
valueSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- valueQuery
or
valueSearch
is not of this servicemandatory
- This method must be implemented. ValueQuery getValueQueryFromInspector(ValueQueryInspector valueQueryInspector)
ValueSearchResults.
valueQueryInspector
- a value query inspectorNullArgumentException
- valueQueryInspector
is null
UnsupportedException
- valueQueryInspector
is not of this servicemandatory
- This method must be implemented.