OSID - osid.control.SceneSearchSession Service Interface Definition

Interface	osid.control.SceneSearchSession
Implements	`osid.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.`
Method	getSceneSearch
Description	Gets a scene search.
Return	`osid.control.SceneSearch`		the scene search
Compliance	`mandatory`		This method must be implemented.
Method	getSceneSearchOrder
Description	Gets a scene search order. The `SceneSearchOrder` is supplied to a `SceneSearch` to specify the ordering of results.
Return	`osid.control.SceneSearchOrder`		the scene search order
Compliance	`mandatory`		This method must be implemented.
Method	getScenesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.control.SceneQuery`	`sceneQuery`	the scene query
Parameters	`osid.control.SceneSearch`	`sceneSearch`	the scene search
Return	`osid.control.SceneSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`sceneQuery` or `sceneSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`sceneQuery` or `sceneSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getSceneQueryFromInspector
Description	Gets a scene query from an inspector. The inspector is available from a `SceneSearchResults.`
Parameters	`osid.control.SceneQueryInspector`	`sceneQueryInspector`	a scene query inspector
Return	`osid.control.SceneQuery`		the scene query
Errors	NULL_ARGUMENT		`sceneQueryInspector` is `null`
Errors	UNSUPPORTED		`sceneQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.