public interface SceneQuerySession extends OsidSession
This session provides methods for searching among Scene
objects. The search query is constructed using the SceneQuery.
This session defines views that offer differing behaviors for searching.
scenes may have a query record indicated by their respective record
types. The query record is accessed via the SceneQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchScenes()
Tests if this user can perform
Scene lookups. |
SceneQuery |
getSceneQuery()
Gets a scene query.
|
SceneList |
getScenesByQuery(SceneQuery sceneQuery)
Gets a list of
Scenes matching the given scene query. |
System |
getSystem()
Gets the
System associated with this session. |
Id |
getSystemId()
Gets the
System Id associated with this
session. |
void |
useFederatedSystemView()
Federates the view for methods in this session.
|
void |
useIsolatedSystemView()
Isolates the view for methods in this session.
|
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 canSearchScenes()
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 search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedSystemView()
mandatory
- This method is must be implemented. void useIsolatedSystemView()
mandatory
- This method is must be implemented. SceneQuery getSceneQuery()
mandatory
- This method must be implemented. SceneList getScenesByQuery(SceneQuery sceneQuery) throws OperationFailedException, PermissionDeniedException
Scenes
matching the given scene query.sceneQuery
- the scene query SceneList
NullArgumentException
- sceneQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- sceneQuery
is not
of this servicemandatory
- This method must be implemented.