public interface ValueEnablerSearchSession extends ValueEnablerQuerySession
This session provides methods for searching among ValueEnabler
objects. The search query is constructed using the
ValueEnableryQuery.
getValueEnablersByQuery()
is the basic search method
and returns a list of ValueEnablers.
A more advanced search
may be performed with getValueEnablersBySearch().
It
accepts a ValueEnablerSearch
in addition to the query for
the purpose of specifying additional options affecting the entire search,
such as configuration. getValueEnablersBySearch()
returns a
ValueEnablerSearchResults
that can be used to access the
resulting ValueEnablerList
or be used to perform a search
within the result set through ValueEnablerSearch.
This session defines views that offer differing behaviors for searching.
ValueEnablers
may have a query record indicated by
their respective record types. The query record is accessed via the
ValueEnablerQuery.
Modifier and Type | Method and Description |
---|---|
ValueEnablerQuery |
getValueEnablerQueryFromInspector(ValueEnablerQueryInspector valueEnablerQueryInspector)
Gets a value enabler query from an inspector.
|
ValueEnablerSearchResults |
getValueEnablersBySearch(ValueEnablerQuery valueEnablerQuery,
ValueEnablerSearch valueEnablerSearch)
Gets the search results matching the given search query using the
given search.
|
ValueEnablerSearch |
getValueEnablerSearch()
Gets a value enabler search.
|
ValueEnablerSearchOrder |
getValueEnablerSearchOrder()
Gets a value enabler search order.
|
canSearchValueEnablers, getConfiguration, getConfigurationId, getValueEnablerQuery, getValueEnablersByQuery, useFederatedConfigurationView, useIsolatedConfigurationView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ValueEnablerSearch getValueEnablerSearch()
mandatory
- This method must be implemented. ValueEnablerSearchOrder getValueEnablerSearchOrder()
ValueEnablerSearchOrder
is supplied to a ValueEnablerSearch
to specify
the ordering of results.mandatory
- This method must be implemented. ValueEnablerSearchResults getValueEnablersBySearch(ValueEnablerQuery valueEnablerQuery, ValueEnablerSearch valueEnablerSearch) throws OperationFailedException, PermissionDeniedException
valueEnablerQuery
- the value enabler queryvalueEnablerSearch
- the value enabler searchNullArgumentException
- valueEnablerQuery
or valueEnablerSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- valueEnablerQuery
or valueEnablerSearch
is not of this servicemandatory
- This method must be implemented. ValueEnablerQuery getValueEnablerQueryFromInspector(ValueEnablerQueryInspector valueEnablerQueryInspector)
ValueEnablerSearchResults.
valueEnablerQueryInspector
- a value enabler query inspectorNullArgumentException
-
valueEnablerQueryInspector
is null
UnsupportedException
-
valueEnablerQueryInspector
is not of this servicemandatory
- This method must be implemented.