public interface DeviceEnablerSmartSystemSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
systems. A DeviceEnablerQuery
can be retrieved from this
session and mapped to this System
to create a virtual
collection of device enablers. The device enablers may be sequenced using
the DeviceEnablerSearchOrder
from this session.
This System
has a default query that matches any device
enabler and a default search order that specifies no sequencing. The
queries may be examined using a DeviceEnablerQueryInspector.
The query may be modified by converting the inspector back to a
DeviceEnablerQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyDeviceEnablerQuery(DeviceEnablerQuery deviceEnablerQuery)
Applies a device enabler query to this system.
|
void |
applyDeviceEnablerSequencing(DeviceEnablerSearchOrder deviceEnablerSearchOrder)
Applies a device enabler search order to this system
|
boolean |
canManageSmartSystems()
Tests if this user can manage smart systems.
|
DeviceEnablerQuery |
getDeviceEnablerQuery()
Gets a device enabler query.
|
DeviceEnablerQuery |
getDeviceEnablerQueryFromInspector(DeviceEnablerQueryInspector deviceEnablerQueryInspector)
Gets a device enabler query from an inspector.
|
DeviceEnablerSearchOrder |
getDeviceEnablerSearchOrder()
Gets a device enabler search order.
|
System |
getSystem()
Gets the
System associated with this session. |
Id |
getSystemId()
Gets the
System Id associated with this
session. |
DeviceEnablerQueryInspector |
inspectDeviceEnablerQuery()
Gets a device enabler query inspector for this system.
|
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 canManageSmartSystems()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart system management is not
authorized, true
otherwisemandatory
- This method must be implemented. DeviceEnablerQuery getDeviceEnablerQuery()
mandatory
- This method must be implemented. DeviceEnablerSearchOrder getDeviceEnablerSearchOrder()
mandatory
- This method must be implemented. void applyDeviceEnablerQuery(DeviceEnablerQuery deviceEnablerQuery) throws OperationFailedException, PermissionDeniedException
deviceEnablerQuery
- the device enabler queryNullArgumentException
- deviceEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- deviceEnablerQuery
not of this servicemandatory
- This method must be implemented. DeviceEnablerQueryInspector inspectDeviceEnablerQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyDeviceEnablerSequencing(DeviceEnablerSearchOrder deviceEnablerSearchOrder) throws OperationFailedException, PermissionDeniedException
deviceEnablerSearchOrder
- the device enabler search orderNullArgumentException
- deviceEnablerSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- deviceEnablerSearchOrder
not of this servicemandatory
- This method must be implemented. DeviceEnablerQuery getDeviceEnablerQueryFromInspector(DeviceEnablerQueryInspector deviceEnablerQueryInspector)
deviceEnablerQueryInspector
- a device enabler query inspectorNullArgumentException
-
deviceEnablerQueryInspector
is null
UnsupportedException
-
deviceEnablerQueryInspector
is not of this servicemandatory
- This method must be implemented.