OSID Logo
OSID Specifications
control package
Version 3.1.0
Interfaceosid.control.SceneSearchResults
Implementsosid.OsidSearchResults
Used Byosid.control.SceneSearchSession
Description

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

MethodgetScenes
Description

Gets the scene list resulting from a search.

Returnosid.control.SceneList the scene list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetSceneQueryInspector
Description

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

Returnosid.control.SceneQueryInspector the scene query inspector
Compliancemandatory This 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.TypesceneSearchRecordType a scene search record type
Returnosid.control.records.SceneSearchResultsRecord the scene search results record
ErrorsNULL_ARGUMENT sceneSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(sceneSearchRecordType) is false
Compliancemandatory This method must be implemented.