public interface DeviceSearchSession extends DeviceQuerySession
This session provides methods for searching among Device
objects. The search query is constructed using the DeviceQuery.
getDevicesByQuery()
is the basic search method and
returns a list of Devices.
A more advanced search may be
performed with getDevicesBySearch().
It accepts a
DeviceSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getDevicesBySearch()
returns a
DeviceSearchResults
that can be used to access the resulting
DeviceList
or be used to perform a search within the result
set through DeviceSearch.
This session defines views that offer differing behaviors for searching.
Devices may have a record indicated by their respective record types.
The query record is accessed via the DeviceQuery.
Modifier and Type | Method and Description |
---|---|
DeviceQuery |
getDeviceQueryFromInspector(DeviceQueryInspector deviceQueryInspector)
Gets a device query from an inspector.
|
DeviceSearchResults |
getDevicesBySearch(DeviceQuery deviceQuery,
DeviceSearch deviceSearch)
Gets the search results matching the given search query using the
given search.
|
DeviceSearch |
getDeviceSearch()
Gets a device search.
|
DeviceSearchOrder |
getDeviceSearchOrder()
Gets a device search order.
|
canSearchDevices, getDeviceQuery, getDevicesByQuery, getSystem, getSystemId, useFederatedSystemView, useIsolatedSystemView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
DeviceSearch getDeviceSearch()
mandatory
- This method must be implemented. DeviceSearchOrder getDeviceSearchOrder()
DeviceSearchOrder
is
supplied to a DeviceSearch
to specify the ordering of
results.mandatory
- This method must be implemented. DeviceSearchResults getDevicesBySearch(DeviceQuery deviceQuery, DeviceSearch deviceSearch) throws OperationFailedException, PermissionDeniedException
deviceQuery
- the device querydeviceSearch
- the device searchNullArgumentException
- deviceQuery
or
deviceSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- deviceQuery
or
deviceSearch
is not of this servicemandatory
- This method must be implemented. DeviceQuery getDeviceQueryFromInspector(DeviceQueryInspector deviceQueryInspector)
DeviceSearchResults.
deviceQueryInspector
- a device query inspectorNullArgumentException
- deviceQueryInspector
is null
UnsupportedException
- deviceQueryInspector
is not of this servicemandatory
- This method must be implemented.