public interface SceneLookupSession extends OsidSession
This session defines methods for retrieving scenes.
This lookup session defines several views:
Scenes
with the SceneAdminSession.
The methods useFederatedSystemView()
and
useIsolatedSystemView()
behave as a radio group and one should be
selected before invoking any lookup methods.
Scenes may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the scenes.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupScenes()
Tests if this user can perform
Scene lookups. |
Scene |
getScene(Id sceneId)
Gets the
Scene specified by its Id. |
SceneList |
getScenes()
Gets all scenes.
|
SceneList |
getScenesByGenusType(Type sceneGenusType)
Gets a
SceneList corresponding to the given scene genus
Type which does not include scenes of types derived
from the specified Type. |
SceneList |
getScenesByIds(IdList sceneIds)
Gets a
SceneList corresponding to the given
IdList. |
SceneList |
getScenesByParentGenusType(Type sceneGenusType)
Gets a
SceneList corresponding to the given scene genus
Type and include any additional scenes with genus types
derived from the specified Type. |
SceneList |
getScenesByRecordType(Type sceneRecordType)
Gets a
SceneList containing the given scene record
Type. |
SceneList |
getScenesBySetting(Id settingId)
Gets a list of scenes by a setting.
|
System |
getSystem()
Gets the
System associated with this session. |
Id |
getSystemId()
Gets the
System Id associated with this
session. |
void |
useComparativeSceneView()
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 |
useFederatedSystemView()
Federates the view for methods in this session.
|
void |
useIsolatedSystemView()
Isolates the view for methods in this session.
|
void |
usePlenarySceneView()
A complete view of the
Scene returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getSystemId()
System
Id
associated with this
session. System Id
associated with this sessionmandatory
- This method must be implemented. System getSystem() throws OperationFailedException, PermissionDeniedException
System
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupScenes()
Scene
lookups. A return
of true does not guarantee successful authorization. A return of false
indicates that it is known all methods in this session will result in
a PERMISSION_DENIED.
This is intended as a hint to an
application that may not offer lookup operations to unauthorized
users. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeSceneView()
mandatory
- This method is must be implemented. void usePlenarySceneView()
Scene
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. void useFederatedSystemView()
mandatory
- This method is must be implemented. void useIsolatedSystemView()
mandatory
- This method is must be implemented. Scene getScene(Id sceneId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Scene
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
Scene
may have a different Id
than requested,
such as the case where a duplicate Id
was assigned to a
Scene
and retained for compatibility.sceneId
- the Id
of the Scene
to
retrieve Scene
NotFoundException
- no Scene
found with
the given Id
NullArgumentException
- sceneId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SceneList getScenesByIds(IdList sceneIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
SceneList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
scenes specified in the Id
list, in the order of the
list, including duplicates, or an error results if an Id
in the supplied list is not found or inaccessible. Otherwise,
inaccessible Scenes
may be omitted from the list and
may present the elements in any order including returning a unique
set.sceneIds
- the list of Ids
to retrieve Scene
listNotFoundException
- an Id
was not foundNullArgumentException
- sceneIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SceneList getScenesByGenusType(Type sceneGenusType) throws OperationFailedException, PermissionDeniedException
SceneList
corresponding to the given scene genus
Type
which does not include scenes of types derived
from the specified Type.
In plenary mode, the returned list contains all known
scenes or an error results. Otherwise, the returned list may contain
only those scenes that are accessible through this session.sceneGenusType
- a scene genus type Scene
listNullArgumentException
- sceneGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SceneList getScenesByParentGenusType(Type sceneGenusType) throws OperationFailedException, PermissionDeniedException
SceneList
corresponding to the given scene genus
Type
and include any additional scenes with genus types
derived from the specified Type.
In plenary mode, the returned list contains all known
scenes or an error results. Otherwise, the returned list may contain
only those scenes that are accessible through this session.sceneGenusType
- a scene genus type Scene
listNullArgumentException
- sceneGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SceneList getScenesByRecordType(Type sceneRecordType) throws OperationFailedException, PermissionDeniedException
SceneList
containing the given scene record
Type.
In plenary mode, the returned list contains all known scenes or an
error results. Otherwise, the returned list may contain only those
scenes that are accessible through this session.sceneRecordType
- a scene record type Scene
listNullArgumentException
- sceneRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SceneList getScenesBySetting(Id settingId) throws OperationFailedException, PermissionDeniedException
In plenary mode, the returned list contains all known
scenes or an error results. Otherwise, the returned list may contain
only those scenes that are accessible through this session.settingId
- a setting Id
Scene
listNullArgumentException
- settingId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SceneList getScenes() throws OperationFailedException, PermissionDeniedException
In plenary mode, the returned list contains all of the
scenes including duplicates, or an error results if an Id
in the supplied list is not found or inaccessible. Otherwise,
inaccessible Scenes
may be omitted from the list and
may present the elements in any order including returning a unique
set. Scene
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.