Interface | osid.control.SceneSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getScenes | ||
Description |
Gets the scene list resulting from a search. | ||
Return | osid.control.SceneList | the scene list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getSceneQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.control.SceneQueryInspector | the scene query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getSceneSearchResultsRecord | ||
Description |
Gets the scene search results record corresponding to
the given scene search record | ||
Parameters | osid.type.Type | sceneSearchRecordType | a scene search record type |
Return | osid.control.records.SceneSearchResultsRecord | the scene search results record | |
Errors | NULL_ARGUMENT | sceneSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(sceneSearchRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |