public interface DeviceSmartSystemSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A DeviceQuery
can be retrieved from this session
and systemped to this System
to create a virtual collection
of Devices.
The devices may be sequenced using the
DeviceSearchOrder
from this session.
This System
has a default query that matches any device
and a default search order that specifies no sequencing. The queries may
be examined using a DeviceQueryInspector.
The query may be
modified by converting the inspector back to a DeviceQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyDeviceQuery(DeviceQuery deviceQuery)
Applies a device query to this system.
|
void |
applyDeviceSequencing(DeviceSearchOrder deviceSearchOrder)
Applies a device search order to this system.
|
boolean |
canManageSmartSystems()
Tests if this user can manage smart systems.
|
DeviceQuery |
getDeviceQuery()
Gets a device query.
|
DeviceQuery |
getDeviceQueryFromInspector(DeviceQueryInspector deviceQueryInspector)
Gets a device query from an inspector.
|
DeviceSearchOrder |
getDeviceSearchOrder()
Gets a device search order.
|
System |
getSystem()
Gets the
System associated with this session. |
Id |
getSystemId()
Gets the
System Id associated with this
session. |
DeviceQueryInspector |
inspectDeviceQuery()
Gets a device 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. DeviceQuery getDeviceQuery()
mandatory
- This method must be implemented. DeviceSearchOrder getDeviceSearchOrder()
mandatory
- This method must be implemented. void applyDeviceQuery(DeviceQuery deviceQuery) throws OperationFailedException, PermissionDeniedException
deviceQuery
- the device queryNullArgumentException
- deviceQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- deviceQuery
not
of this servicemandatory
- This method must be implemented. DeviceQueryInspector inspectDeviceQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyDeviceSequencing(DeviceSearchOrder deviceSearchOrder) throws OperationFailedException, PermissionDeniedException
deviceSearchOrder
- the device search orderNullArgumentException
- deviceSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- deviceSearchOrder
not of this servicemandatory
- This method must be implemented. DeviceQuery getDeviceQueryFromInspector(DeviceQueryInspector deviceQueryInspector)
deviceQueryInspector
- a device query inspectorNullArgumentException
- deviceQueryInspector
is null
UnsupportedException
- deviceQueryInspector
is not of this servicemandatory
- This method must be implemented.