Interface SceneSystemSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface SceneSystemSession
extends OsidSession

This session provides methods to retrieve Scene to System scenes. A Scene may appear in multiple Systems . Each system may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition

Method Summary

Modifier and Type	Method	Description
boolean	canLookupSceneSystemScenes()	Tests if this user can perform lookups of scene/system mappings.
IdList	getSceneIdsBySystem(Id systemId)	Gets the list of Scene Ids associated with a System .
IdList	getSceneIdsBySystems(IdList systemIds)	Gets the list of Scene Ids corresponding to a list of Systems .
SceneList	getScenesBySystem(Id systemId)	Gets the list of Scenes associated with a System .
SceneList	getScenesBySystems(IdList systemIds)	Gets the list of Scenes corresponding to a list of Systems .
IdList	getSystemIdsByScene(Id sceneId)	Gets the System Ids mapped to a Scene .
SystemList	getSystemsByScene(Id sceneId)	Gets the Systems mapped to a Scene .
void	useComparativeSceneSystemView()	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenarySceneSystemView()	A complete view of the Scene and System returns is desired.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

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

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

canLookupSceneSystemScenes

boolean canLookupSceneSystemScenes()

Tests if this user can perform lookups of scene/system mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.

Returns:

false if looking up scenes is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeSceneSystemView

void useComparativeSceneSystemView()

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenarySceneSystemView

void usePlenarySceneSystemView()

A complete view of the Scene and System returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

getSceneIdsBySystem

IdList getSceneIdsBySystem(Id systemId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Scene Ids associated with a System .

Parameters:

systemId - Id of the System

Returns:

list of related scene Ids

Throws:

NotFoundException - systemId is not found

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getScenesBySystem

SceneList getScenesBySystem(Id systemId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Scenes associated with a System .

Parameters:

systemId - Id of the System

Returns:

list of related scenes

Throws:

NotFoundException - systemId is not found

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSceneIdsBySystems

IdList getSceneIdsBySystems(IdList systemIds)
                     throws OperationFailedException,
PermissionDeniedException

Gets the list of Scene Ids corresponding to a list of Systems .

Parameters:

systemIds - list of system Ids

Returns:

list of scene Ids

Throws:

NullArgumentException - systemIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getScenesBySystems

SceneList getScenesBySystems(IdList systemIds)
                      throws OperationFailedException,
PermissionDeniedException

Gets the list of Scenes corresponding to a list of Systems .

Parameters:

systemIds - list of system Ids

Returns:

list of scenes

Throws:

NullArgumentException - systemIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSystemIdsByScene

IdList getSystemIdsByScene(Id sceneId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the System Ids mapped to a Scene .

Parameters:

sceneId - Id of a Scene

Returns:

list of systems

Throws:

NotFoundException - sceneId is not found

NullArgumentException - sceneId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSystemsByScene

SystemList getSystemsByScene(Id sceneId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Systems mapped to a Scene .

Parameters:

sceneId - Id of a Scene

Returns:

list of systems

Throws:

NotFoundException - sceneId is not found

NullArgumentException - sceneId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.