org.osid.control

Interface SceneSmartSystemSession

All Superinterfaces:

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

public interface SceneSmartSystemSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A SceneQuery can be retrieved from this session and systemped to this System to create a virtual collection of Scenes. The scenes may be sequenced using the SceneSearchOrder from this session.

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

Method Summary

Methods

Modifier and Type	Method and Description
void	applySceneQuery(SceneQuery sceneQuery) Applies a scene query to this system.
void	applySceneSequencing(SceneSearchOrder sceneSearchOrder) Applies a scene search order to this system.
boolean	canManageSmartSystems() Tests if this user can manage smart systems.
SceneQuery	getSceneQuery() Gets a scene query.
SceneQuery	getSceneQueryFromInspector(SceneQueryInspector sceneQueryInspector) Gets a scene query from an inspector.
SceneSearchOrder	getSceneSearchOrder() Gets a scene search order.
System	getSystem() Gets the System associated with this session.
Id	getSystemId() Gets the System Id associated with this session.
SceneQueryInspector	inspectSceneQuery() Gets a scene 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.

getSceneQuery

SceneQuery getSceneQuery()

Gets a scene query.

Returns:

the scene query

Compliance:

mandatory - This method must be implemented.

getSceneSearchOrder

SceneSearchOrder getSceneSearchOrder()

Gets a scene search order.

Returns:

the scene search order

Compliance:

mandatory - This method must be implemented.

applySceneQuery

void applySceneQuery(SceneQuery sceneQuery)
                     throws OperationFailedException,
                            PermissionDeniedException

Applies a scene query to this system.

Parameters:

sceneQuery - the scene query

Throws:

NullArgumentException - sceneQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - sceneQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectSceneQuery

SceneQueryInspector inspectSceneQuery()
                                      throws OperationFailedException,
                                             PermissionDeniedException

Gets a scene query inspector for this system.

Returns:

the scene query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applySceneSequencing

void applySceneSequencing(SceneSearchOrder sceneSearchOrder)
                          throws OperationFailedException,
                                 PermissionDeniedException

Applies a scene search order to this system.

Parameters:

sceneSearchOrder - the scene search order

Throws:

NullArgumentException - sceneSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - sceneSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getSceneQueryFromInspector

SceneQuery getSceneQueryFromInspector(SceneQueryInspector sceneQueryInspector)

Gets a scene query from an inspector.

Parameters:

sceneQueryInspector - a scene query inspector

Returns:

the scene query

Throws:

NullArgumentException - sceneQueryInspector is null

UnsupportedException - sceneQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.