OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
control package
Version 3.0.0
Release Candidate Preview
| Interface | osid.control.SceneSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing scene searches. | ||
| Method | searchAmongScenes | ||
| Description |
Execute this search among the given list of scenes. | ||
| Parameters | osid.id.IdList | sceneIds | list of scenes |
| Errors | NULL_ARGUMENT | sceneIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderSceneResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.control.SceneSearchOrder | sceneSearchOrder | scene search order |
| Errors | NULL_ARGUMENT | sceneSearchOrder is null | |
| UNSUPPORTED | sceneSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getSceneSearchRecord | ||
| Description |
Gets the scene search record corresponding to the given
scene search record | ||
| Parameters | osid.type.Type | sceneSearchRecordType | a scene search record type |
| Return | osid.control.records.SceneSearchRecord | the scene search interface | |
| Errors | NULL_ARGUMENT | sceneSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(sceneSearchRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |