public interface DeviceEnablerSearchSession extends DeviceEnablerQuerySession
This session provides methods for searching among DeviceEnabler
objects. The search query is constructed using the
DeviceEnableryQuery.
getDeviceEnablersByQuery()
is the basic search method
and returns a list of DeviceEnablers.
A more advanced
search may be performed with getDeviceEnablersBySearch().
It accepts a DeviceEnablerSearch
in addition to the query
for the purpose of specifying additional options affecting the entire
search, such as offering. getDeviceEnablersBySearch()
returns a DeviceEnablerSearchResults
that can be used to
access the resulting DeviceEnablerList
or be used to
perform a search within the result set through DeviceEnablerSearch.
This session defines views that offer differing behaviors for searching.
DeviceEnablers
may have a query record indicated by
their respective record types. The query record is accessed via the
DeviceEnablerQuery.
Modifier and Type | Method and Description |
---|---|
DeviceEnablerQuery |
getDeviceEnablerQueryFromInspector(DeviceEnablerQueryInspector deviceEnablerQueryInspector)
Gets a device enabler query from an inspector.
|
DeviceEnablerSearchResults |
getDeviceEnablersBySearch(DeviceEnablerQuery deviceEnablerQuery,
DeviceEnablerSearch deviceEnablerSearch)
Gets the search results matching the given search query using the
given search.
|
DeviceEnablerSearch |
getDeviceEnablerSearch()
Gets a device enabler search.
|
DeviceEnablerSearchOrder |
getDeviceEnablerSearchOrder()
Gets a device enabler search order.
|
canSearchDeviceEnablers, getDeviceEnablerQuery, getDeviceEnablersByQuery, getSystem, getSystemId, useFederatedSystemView, useIsolatedSystemView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
DeviceEnablerSearch getDeviceEnablerSearch()
mandatory
- This method must be implemented. DeviceEnablerSearchOrder getDeviceEnablerSearchOrder()
DeviceEnablerSearchOrder
is supplied to a
DeviceEnablerSearch
to specify the ordering of results.mandatory
- This method must be implemented. DeviceEnablerSearchResults getDeviceEnablersBySearch(DeviceEnablerQuery deviceEnablerQuery, DeviceEnablerSearch deviceEnablerSearch) throws OperationFailedException, PermissionDeniedException
deviceEnablerQuery
- the device enabler querydeviceEnablerSearch
- the device enabler searchNullArgumentException
- deviceEnablerQuery
or deviceEnablerSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- deviceEnablerQuery
or deviceEnablerSearch
is not of this
servicemandatory
- This method must be implemented. DeviceEnablerQuery getDeviceEnablerQueryFromInspector(DeviceEnablerQueryInspector deviceEnablerQueryInspector)
DeviceEnablerSearchResults.
deviceEnablerQueryInspector
- a device enabler query inspectorNullArgumentException
-
deviceEnablerQueryInspector
is null
UnsupportedException
-
deviceEnablerQueryInspector
is not of this servicemandatory
- This method must be implemented.