public interface SceneSearchSession extends SceneQuerySession
This session provides methods for searching among Scene
objects. The search query is constructed using the SceneQuery.
getScenesByQuery()
is the basic search method and
returns a list of Scenes.
A more advanced search may be
performed with getScenesBySearch().
It accepts an
SceneSearch
in addition to the query for the purpose of specifying
additional options affecting the entire search, such as ordering.
getScenesBySearch()
returns an SceneSearchResults
that can be used to access the resulting SceneList
or be
used to perform a search within the result set through SceneSearch.
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 |
---|---|
SceneQuery |
getSceneQueryFromInspector(SceneQueryInspector sceneQueryInspector)
Gets a scene query from an inspector.
|
SceneSearchResults |
getScenesBySearch(SceneQuery sceneQuery,
SceneSearch sceneSearch)
Gets the search results matching the given search query using the
given search.
|
SceneSearch |
getSceneSearch()
Gets a scene search.
|
SceneSearchOrder |
getSceneSearchOrder()
Gets a scene search order.
|
canSearchScenes, getSceneQuery, getScenesByQuery, getSystem, getSystemId, useFederatedSystemView, useIsolatedSystemView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
SceneSearch getSceneSearch()
mandatory
- This method must be implemented. SceneSearchOrder getSceneSearchOrder()
SceneSearchOrder
is
supplied to a SceneSearch
to specify the ordering of
results.mandatory
- This method must be implemented. SceneSearchResults getScenesBySearch(SceneQuery sceneQuery, SceneSearch sceneSearch) throws OperationFailedException, PermissionDeniedException
sceneQuery
- the scene querysceneSearch
- the scene searchNullArgumentException
- sceneQuery
or
sceneSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- sceneQuery
or
sceneSearch
is not of this servicemandatory
- This method must be implemented. SceneQuery getSceneQueryFromInspector(SceneQueryInspector sceneQueryInspector)
SceneSearchResults.
sceneQueryInspector
- a scene query inspectorNullArgumentException
- sceneQueryInspector
is null
UnsupportedException
- sceneQueryInspector
is not of this servicemandatory
- This method must be implemented.