OSID Logo
OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.SceneSearchResults
Implementsosid.OsidSearchResults
Description

This interface provides a means to capture results of a search.

MethodgetScenes
Description

Gets the scene list resulting from a search.

Returnosid.control.SceneListthe scene list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetSceneQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.control.SceneQueryInspectorthe scene query inspector
CompliancemandatoryThis method must be implemented.
MethodgetSceneSearchResultsRecord
Description

Gets the scene search results record corresponding to the given scene search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypesceneSearchRecordTypea scene search record type
Returnosid.control.records.SceneSearchResultsRecordthe scene search results record
ErrorsNULL_ARGUMENT sceneSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(sceneSearchRecordType) is false
CompliancemandatoryThis method must be implemented.