org.osid.control.rules

Interface DeviceEnablerSmartSystemSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getSystemId

Id getSystemId()

Gets the System Id associated with this session.

Returns:

the System Id associated with this session

Compliance:

mandatory - This method must be implemented.

getSystem

System getSystem()
                 throws OperationFailedException,
                        PermissionDeniedException

Gets the System associated with this session.

Returns:

the system

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageSmartSystems

boolean canManageSmartSystems()

Tests if this user can manage smart systems. A return of true does not guarantee successful authorization. A return of false indicates that it is known methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer operations to unauthorized users.

Returns:

false if smart system management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getDeviceEnablerQuery

DeviceEnablerQuery getDeviceEnablerQuery()

Gets a device enabler query.

Returns:

the device enabler query

Compliance:

mandatory - This method must be implemented.

getDeviceEnablerSearchOrder

DeviceEnablerSearchOrder getDeviceEnablerSearchOrder()

Gets a device enabler search order.

Returns:

the device enabler search order

Compliance:

mandatory - This method must be implemented.

applyDeviceEnablerQuery

void applyDeviceEnablerQuery(DeviceEnablerQuery deviceEnablerQuery)
                             throws OperationFailedException,
                                    PermissionDeniedException

Applies a device enabler query to this system.

Parameters:

deviceEnablerQuery - the device enabler query

Throws:

NullArgumentException - deviceEnablerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - deviceEnablerQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectDeviceEnablerQuery

DeviceEnablerQueryInspector inspectDeviceEnablerQuery()
                                                      throws OperationFailedException,
                                                             PermissionDeniedException

Gets a device enabler query inspector for this system.

Returns:

the device enabler query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyDeviceEnablerSequencing

void applyDeviceEnablerSequencing(DeviceEnablerSearchOrder deviceEnablerSearchOrder)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Applies a device enabler search order to this system

Parameters:

deviceEnablerSearchOrder - the device enabler search order

Throws:

NullArgumentException - deviceEnablerSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - deviceEnablerSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getDeviceEnablerQueryFromInspector

DeviceEnablerQuery getDeviceEnablerQueryFromInspector(DeviceEnablerQueryInspector deviceEnablerQueryInspector)

Gets a device enabler query from an inspector.

Parameters:

deviceEnablerQueryInspector - a device enabler query inspector

Returns:

the device enabler query

Throws:

NullArgumentException - deviceEnablerQueryInspector is null

UnsupportedException - deviceEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.