OSID Logo
OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.SceneList
Implementsosid.OsidList
Description

Like all OsidLists, SceneList provides a means for accessing Scene elements sequentially either one at a time or many at a time. Examples:

                     
                     
                     while (sl.hasNext()) {
                          Scene scene = sl.getNextScene();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (sl.hasNext()) {
                          Scene[] scenes = sl.getNextScenesspl.available());
                     }
                     
                                 
                     
                
MethodgetNextScene
Description

Gets the next Scene in this list.

Returnosid.control.Scenethe next Scene in this list. The hasNext() method should be used to test that a next Scene is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextScenes
Description

Gets the next set of Scene elements in this list. The specified amount must be less than or equal to the return from available().

Parameterscardinalnthe number of Scene elements requested which must be less than or equal to available()
Returnosid.control.Scene[]an array of Scene elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.