Interface | osid.control.SceneSearchSession | ||
---|---|---|---|
Implements | osid.control.SceneQuerySession | ||
Description |
This session provides methods for searching among 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
| ||
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 | ||
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 |
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 | ||
Parameters | osid.control.SceneQueryInspector | sceneQueryInspector | a scene query inspector |
Return | osid.control.SceneQuery | the scene query | |
Errors | NULL_ARGUMENT | sceneQueryInspector is null | |
UNSUPPORTED | sceneQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |