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

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

                     
                     
                     while (pbfl.hasNext()) {
                          ParameterBatchForm form = pbfl.getNextParameterBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pbfl.hasNext()) {
                          ParameterBatchForm[] forms = pbfl.getNextParameterBatchForms(pbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextParameterBatchForm
Description

Gets the next ParameterBatchForm in this list.

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

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

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