public interface DeviceEnablerQuerySession extends OsidSession
This session provides methods for searching among DeviceEnabler
objects. The search query is constructed using the
DeviceEnablerQuery.
This session defines views that offer differing behaviors for searching.
Device constrainer enablers 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 |
---|---|
boolean |
canSearchDeviceEnablers()
Tests if this user can perform
DeviceEnabler lookups. |
DeviceEnablerQuery |
getDeviceEnablerQuery()
Gets a device enabler query.
|
DeviceEnablerList |
getDeviceEnablersByQuery(DeviceEnablerQuery deviceEnablerQuery)
Gets a list of
DeviceEnablers matching the given
search. |
System |
getSystem()
Gets the
System associated with this session. |
Id |
getSystemId()
Gets the
System Id associated with this
session. |
void |
useFederatedSystemView()
Federates the view for methods in this session.
|
void |
useIsolatedSystemView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getSystemId()
System
Id
associated with this
session. System Id
associated with this sessionmandatory
- This method must be implemented. System getSystem() throws OperationFailedException, PermissionDeniedException
System
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchDeviceEnablers()
DeviceEnabler
lookups. A
return of true does not guarantee successful authorization. A return
of false indicates that it is known all methods in this session will
result in a PERMISSION_DENIED.
This is intended as a
hint to an application that may not offer lookup operations to
unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedSystemView()
mandatory
- This method is must be implemented. void useIsolatedSystemView()
mandatory
- This method is must be implemented. DeviceEnablerQuery getDeviceEnablerQuery()
mandatory
- This method must be implemented. DeviceEnablerList getDeviceEnablersByQuery(DeviceEnablerQuery deviceEnablerQuery) throws OperationFailedException, PermissionDeniedException
DeviceEnablers
matching the given
search.deviceEnablerQuery
- the device constraienr enabler query DeviceEnablerList
NullArgumentException
- deviceEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- deviceEnablerQuery
is not of this servicemandatory
- This method must be implemented.