public interface SceneSystemSession extends OsidSession
This session provides methods to retrieve Scene
to
System
scenes. A Scene
may appear in
multiple System
objects. Each system may have its own
authorizations governing who is allowed to look at it.
This lookup session defines several views:
Modifier and Type | Method and 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. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupSceneSystemScenes()
PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer lookup operations
to unauthorized users. false
if looking up scenes is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeSceneSystemView()
mandatory
- This method is must be implemented. void usePlenarySceneSystemView()
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.mandatory
- This method is must be implemented. IdList getSceneIdsBySystem(Id systemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Scene Ids
associated with a
System.
systemId
- Id
of the System
Ids
NotFoundException
- systemId
is not
foundNullArgumentException
- systemId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SceneList getScenesBySystem(Id systemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Scenes
associated with a
System.
systemId
- Id
of the System
NotFoundException
- systemId
is not
foundNullArgumentException
- systemId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getSceneIdsBySystems(IdList systemIds) throws OperationFailedException, PermissionDeniedException
Scene Ids
corresponding to a list of
Systems.
systemIds
- list of system Ids
Ids
NullArgumentException
- systemIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SceneList getScenesBySystems(IdList systemIds) throws OperationFailedException, PermissionDeniedException
Scenes
corresponding to a list of
Systems.
systemIds
- list of system Ids
NullArgumentException
- systemIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getSystemIdsByScene(Id sceneId) throws NotFoundException, OperationFailedException, PermissionDeniedException
System
Ids
mapped to a
Scene.
sceneId
- Id
of a Scene
NotFoundException
- sceneId
is not foundNullArgumentException
- sceneId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SystemList getSystemsByScene(Id sceneId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Systems
mapped to a Scene.
sceneId
- Id
of a Scene
NotFoundException
- sceneId
is not foundNullArgumentException
- sceneId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.