OSID Logo
OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.SceneSearchSession
Implementsosid.control.SceneQuerySession
Description

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.

  • federated system view: searches include scenes in systems of which this system is an ancestor in the system hierarchy
  • isolated system view: searches are restricted to scenes in this system

Scenes may have a query record indicated by their respective record types. The query record is accessed via the SceneQuery.

MethodgetSceneSearch
Description

Gets a scene search.

Returnosid.control.SceneSearchthe scene search
CompliancemandatoryThis method must be implemented.
MethodgetSceneSearchOrder
Description

Gets a scene search order. The SceneSearchOrder is supplied to a SceneSearch to specify the ordering of results.

Returnosid.control.SceneSearchOrderthe scene search order
CompliancemandatoryThis method must be implemented.
MethodgetScenesBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.control.SceneQuerysceneQuerythe scene query
osid.control.SceneSearchsceneSearchthe scene search
Returnosid.control.SceneSearchResultsthe returned search results
ErrorsNULL_ARGUMENT sceneQuery or sceneSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED sceneQuery or sceneSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetSceneQueryFromInspector
Description

Gets a scene query from an inspector. The inspector is available from a SceneSearchResults.

Parametersosid.control.SceneQueryInspectorsceneQueryInspectora scene query inspector
Returnosid.control.SceneQuerythe scene query
ErrorsNULL_ARGUMENT sceneQueryInspector is null
UNSUPPORTED sceneQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.