org.osid.control.rules

Interface InputEnablerSmartSystemSession

All Superinterfaces:

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

public interface InputEnablerSmartSystemSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic systems. An InputEnablerQuery can be retrieved from this session and mapped to this System to create a virtual collection of input enablers. The input enablers may be sequenced using the InputEnablerSearchOrder from this session.

This System has a default query that matches any input enabler and a default search order that specifies no sequencing. The queries may be examined using an InputEnablerQueryInspector. The query may be modified by converting the inspector back to an InputEnablerQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyInputEnablerQuery(InputEnablerQuery inputEnablerQuery) Applies an input enabler query to this system.
void	applyInputEnablerSequencing(InputEnablerSearchOrder inputEnablerSearchOrder) Applies an input enabler search order to this system.
boolean	canManageSmartSystems() Tests if this user can manage smart systems.
InputEnablerQuery	getInputEnablerQuery() Gets an input enabler query.
InputEnablerQuery	getInputEnablerQueryFromInspector(InputEnablerQueryInspector inputEnablerQueryInspector) Gets an input enabler query from an inspector.
InputEnablerSearchOrder	getInputEnablerSearchOrder() Gets an input enabler search order.
System	getSystem() Gets the System associated with this session.
Id	getSystemId() Gets the System Id associated with this session.
InputEnablerQueryInspector	inspectInputEnablerQuery() Gets an input 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.

getInputEnablerQuery

InputEnablerQuery getInputEnablerQuery()

Gets an input enabler query.

Returns:

the input enabler query

Compliance:

mandatory - This method must be implemented.

getInputEnablerSearchOrder

InputEnablerSearchOrder getInputEnablerSearchOrder()

Gets an input enabler search order.

Returns:

the input enabler search order

Compliance:

mandatory - This method must be implemented.

applyInputEnablerQuery

void applyInputEnablerQuery(InputEnablerQuery inputEnablerQuery)
                            throws OperationFailedException,
                                   PermissionDeniedException

Applies an input enabler query to this system.

Parameters:

inputEnablerQuery - the input enabler query

Throws:

NullArgumentException - inputEnablerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - inputEnablerQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectInputEnablerQuery

InputEnablerQueryInspector inspectInputEnablerQuery()
                                                    throws OperationFailedException,
                                                           PermissionDeniedException

Gets an input enabler query inspector for this system.

Returns:

the input enabler query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyInputEnablerSequencing

void applyInputEnablerSequencing(InputEnablerSearchOrder inputEnablerSearchOrder)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Applies an input enabler search order to this system.

Parameters:

inputEnablerSearchOrder - the input enabler search order

Throws:

NullArgumentException - inputEnablerSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - inputEnablerSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getInputEnablerQueryFromInspector

InputEnablerQuery getInputEnablerQueryFromInspector(InputEnablerQueryInspector inputEnablerQueryInspector)

Gets an input enabler query from an inspector.

Parameters:

inputEnablerQueryInspector - an input enabler query inspector

Returns:

the input enabler query

Throws:

NullArgumentException - inputEnablerQueryInspector is null

UnsupportedException - inputEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.