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

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

                     
                     
                     while (sbfl.hasNext()) {
                          SceneBatchForm form = sbfl.getNextSceneBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (sbfl.hasNext()) {
                          SceneBatchForm[] forms = sbfl.getNextSceneBatchForms(sbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextSceneBatchForm
Description

Gets the next SceneBatchForm in this list.

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

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

Parameterscardinalnthe number of SceneBatchForm elements requested which must be less than or equal to available()
Returnosid.control.batch.SceneBatchForm[]an array of SceneBatchForm 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.