public interface SceneSystemAssignmentSession extends OsidSession
This session provides methods to re-assign Scenes
to
System
mappings. A Scene
may appear in
multiple System
objects and removing the last reference to
a Scene
is the equivalent of deleting it. Each
System
may have its own authorizations governing who is allowed to
operate on it.
Adding a reference of a Scene
to another System
is not a copy operation (eg: does not change its Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignSceneToSystem(Id sceneId,
Id systemId)
Adds an existing
Scene to a System. |
boolean |
canAssignScenes()
Tests if this user can alter scene/system mappings.
|
boolean |
canAssignScenesToSystem(Id systemId)
Tests if this user can alter scene/system mappings.
|
IdList |
getAssignableSystemIds(Id systemId)
Gets a list of systems including and under the given system node in
which any scene can be assigned.
|
IdList |
getAssignableSystemIdsForScene(Id systemId,
Id sceneId)
Gets a list of systems including and under the given system node in
which a specific scene can be assigned.
|
void |
reassignSceneToSystem(Id sceneId,
Id fromSystemId,
Id toSystemId)
Moves a
Scene from one System to
another. |
void |
unassignSceneFromSystem(Id sceneId,
Id systemId)
Removes a
Scene from a System. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignScenes()
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer assignment operations to
unauthorized users. false
if scene is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canAssignScenesToSystem(Id systemId)
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer assignment operations to
unauthorized users.systemId
- the Id
of the System
false
if mapping is not authorized, true
otherwiseNullArgumentException
- systemId
is
null
mandatory
- This method must be implemented. IdList getAssignableSystemIds(Id systemId) throws OperationFailedException
systemId
- the Id
of the System
Ids
NullArgumentException
- systemId
is
null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getAssignableSystemIdsForScene(Id systemId, Id sceneId) throws OperationFailedException
systemId
- the Id
of the System
sceneId
- the Id
of the Scene
Ids
NullArgumentException
- systemId
or
sceneId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignSceneToSystem(Id sceneId, Id systemId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Scene
to a System.
sceneId
- the Id
of the Scene
systemId
- the Id
of the System
AlreadyExistsException
- sceneId
is
already assigned to systemId
NotFoundException
- sceneId
or
systemId
not foundNullArgumentException
- sceneId
or
systemId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignSceneFromSystem(Id sceneId, Id systemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Scene
from a System.
sceneId
- the Id
of the Scene
systemId
- the Id
of the System
NotFoundException
- sceneId
or
systemId
not found or sceneId
not
assigned to systemId
NullArgumentException
- sceneId
or
systemId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void reassignSceneToSystem(Id sceneId, Id fromSystemId, Id toSystemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Scene
from one System
to
another. Mappings to other Systems
are unaffected.sceneId
- the Id
of the Scene
fromSystemId
- the Id
of the current
System
toSystemId
- the Id
of the destination
System
NotFoundException
- sceneId, fromSystemId,
or toSystemId
not found or
sceneId
not mapped to fromSystemId
NullArgumentException
- sceneId, fromSystemId,
or toSystemId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.