OSID Logo
OSID Specifications
configuration batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.configuration.batch.ConfigurationBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (cbfl.hasNext()) {
                          ConfigurationBatchForm form = cbfl.getNextConfigurationBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cbfl.hasNext()) {
                          ConfigurationBatchForm[] forms = cbfl.getNextConfigurationBatchForms(cbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextConfigurationBatchForm
Description

Gets the next ConfigurationBatchForm in this list.

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

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

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