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

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

                     
                     
                     while (ibfl.hasNext()) {
                          InputBatchForm form = ibfl.getNextInputBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ibfl.hasNext()) {
                          InputBatchForm[] forms = ibfl.getNextInputBatchForms(ibfl.available());
                     }
                     
                                 
                     
                
MethodgetNextInputBatchForm
Description

Gets the next InputBatchForm in this list.

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

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

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