org.osid.control

Interface DeviceSmartSystemSession

All Superinterfaces:

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

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.

Method Summary

Methods

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.

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.

getDeviceQuery

DeviceQuery getDeviceQuery()

Gets a device query.

Returns:

the device query

Compliance:

mandatory - This method must be implemented.

getDeviceSearchOrder

DeviceSearchOrder getDeviceSearchOrder()

Gets a device search order.

Returns:

the device search order

Compliance:

mandatory - This method must be implemented.

applyDeviceQuery

void applyDeviceQuery(DeviceQuery deviceQuery)
                      throws OperationFailedException,
                             PermissionDeniedException

Applies a device query to this system.

Parameters:

deviceQuery - the device query

Throws:

NullArgumentException - deviceQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - deviceQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectDeviceQuery

DeviceQueryInspector inspectDeviceQuery()
                                        throws OperationFailedException,
                                               PermissionDeniedException

Gets a device query inspector for this system.

Returns:

the device query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyDeviceSequencing

void applyDeviceSequencing(DeviceSearchOrder deviceSearchOrder)
                           throws OperationFailedException,
                                  PermissionDeniedException

Applies a device search order to this system.

Parameters:

deviceSearchOrder - the device search order

Throws:

NullArgumentException - deviceSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - deviceSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getDeviceQueryFromInspector

DeviceQuery getDeviceQueryFromInspector(DeviceQueryInspector deviceQueryInspector)

Gets a device query from an inspector.

Parameters:

deviceQueryInspector - a device query inspector

Returns:

the device query

Throws:

NullArgumentException - deviceQueryInspector is null

UnsupportedException - deviceQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.