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

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

                     
                     
                     while (vbfl.hasNext()) {
                          ValueBatchForm form = vbfl.getNextValueBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (vbfl.hasNext()) {
                          ValueBatchForm[] forms = vbfl.getNextValueBatchForms(vbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextValueBatchForm
Description

Gets the next ValueBatchForm in this list.

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

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

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