OSID Logo
OSID Specifications
control batch package
Version 3.1.0
Interfaceosid.control.batch.SettingBatchFormList
Implementsosid.OsidList
Used Byosid.control.batch.SettingBatchAdminSession
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.SettingBatchForm the next SettingBatchForm in this list. The hasNext() method should be used to test that a next SettingBatchForm 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.
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().

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