org.osid.control

Interface ControllerSmartSystemSession

All Superinterfaces:

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

public interface ControllerSmartSystemSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A ControllerQuery can be retrieved from this session and mapped to this System to create a virtual collection of controllers. The controllers may be sequenced using the ControllerSearchOrder from this session.

This System has a default query that matches any controller and a default search order that specifies no sequencing. The queries may be examined using a ControllerQueryInspector. The query may be modified by converting the inspector back to a ControllerQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyControllerQuery(ControllerQuery controllerQuery) Applies a controller query to this system.
void	applyControllerSequencing(ControllerSearchOrder controllerSearchOrder) Applies a controller search order to this system.
boolean	canManageSmartSystems() Tests if this user can manage smart systems.
ControllerQuery	getControllerQuery() Gets a controller query.
ControllerQuery	getControllerQueryFromInspector(ControllerQueryInspector controllerQueryInspector) Gets a controller query from an inspector.
ControllerSearchOrder	getControllerSearchOrder() Gets a controller search order.
System	getSystem() Gets the System associated with this session.
Id	getSystemId() Gets the System Id associated with this session.
ControllerQueryInspector	inspecControllerQuery() Gets a controller 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.

getControllerQuery

ControllerQuery getControllerQuery()

Gets a controller query.

Returns:

the controller query

Compliance:

mandatory - This method must be implemented.

getControllerSearchOrder

ControllerSearchOrder getControllerSearchOrder()

Gets a controller search order.

Returns:

the controller search order

Compliance:

mandatory - This method must be implemented.

applyControllerQuery

void applyControllerQuery(ControllerQuery controllerQuery)
                          throws OperationFailedException,
                                 PermissionDeniedException

Applies a controller query to this system.

Parameters:

controllerQuery - the controller query

Throws:

NullArgumentException - controllerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - controllerQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspecControllerQuery

ControllerQueryInspector inspecControllerQuery()
                                               throws OperationFailedException,
                                                      PermissionDeniedException

Gets a controller query inspector for this system.

Returns:

the controller query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyControllerSequencing

void applyControllerSequencing(ControllerSearchOrder controllerSearchOrder)
                               throws OperationFailedException,
                                      PermissionDeniedException

Applies a controller search order to this system.

Parameters:

controllerSearchOrder - the controller search order

Throws:

NullArgumentException - controllerSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - controllerSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getControllerQueryFromInspector

ControllerQuery getControllerQueryFromInspector(ControllerQueryInspector controllerQueryInspector)

Gets a controller query from an inspector.

Parameters:

controllerQueryInspector - a controller query inspector

Returns:

the controller query

Throws:

NullArgumentException - controllerQueryInspector is null

UnsupportedException - controllerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.