public interface SignalSearchSession extends SignalQuerySession
This session provides methods for searching among Signal
objects. The search query is constructed using the SignalQuery.
getSignalsByQuery()
is the basic search method and
returns a list of Signals.
A more advanced search may be
performed with getSignalsBySearch().
It accepts a
SignalSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getSignalsBySearch()
returns a
SignalSearchResults
that can be used to access the resulting
SignalList
or be used to perform a search within the result
set through SignalSearch.
This session defines views that offer differing behaviors for searching.
Signals may have a query record indicated by their respective record
types. The query record is accessed via the SignalQuery.
Modifier and Type | Method and Description |
---|---|
SignalQuery |
getSignalQueryFromInspector(SignalQueryInspector signalQueryInspector)
Gets a signal query from an inspector.
|
SignalSearchResults |
getSignalsBySearch(SignalQuery signalQuery,
SignalSearch signalSearch)
Gets the search results matching the given search query using the
given search.
|
SignalSearch |
getSignalSearch()
Gets a signal search.
|
SignalSearchOrder |
getSignalSearchOrder()
Gets a signal search order.
|
canSearchSignals, getMap, getMapId, getSignalQuery, getSignalsByQuery, useFederatedMapView, useIsolatedMapView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
SignalSearch getSignalSearch()
mandatory
- This method must be implemented. SignalSearchOrder getSignalSearchOrder()
SignalSearchOrder
is
supplied to a SignalSearch
to specify the ordering of
results.mandatory
- This method must be implemented. SignalSearchResults getSignalsBySearch(SignalQuery signalQuery, SignalSearch signalSearch) throws OperationFailedException, PermissionDeniedException
signalQuery
- the signal querysignalSearch
- the signal searchNullArgumentException
- signalQuery
or
signalSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- signalQuery
or
signalSearch
is not of this servicemandatory
- This method must be implemented. SignalQuery getSignalQueryFromInspector(SignalQueryInspector signalQueryInspector)
SignalSearchResults.
signalQueryInspector
- a signal query inspectorNullArgumentException
- signalQueryInspector
is null
UnsupportedException
- signalQueryInspector
is not of this servicemandatory
- This method must be implemented.