OSID Logo
OSID Specifications
control package
Version 3.1.0
Interfaceosid.control.SceneList
Implementsosid.OsidList
Used Byosid.control.SceneLookupSession
osid.control.SceneQuerySession
osid.control.SceneSearchResults
osid.control.SceneSystemSession
osid.control.Trigger
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.Scene the next Scene in this list. The hasNext() method should be used to test that a next Scene is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This 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().

Parameterscardinaln the 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_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.