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

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

                     
                     
                     while (sbfl.hasNext()) {
                          SettingBatchForm form = sbfl.getNextSettingBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (sbfl.hasNext()) {
                          SettingBatchForm[] forms = sbfl.getNextSettingBatchForms(sbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextSettingBatchForm
Description

Gets the next SettingBatchForm in this list.

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

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

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