OSID Logo
OSID Specifications
room construction batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.construction.batch.RenovationBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (rbfl.hasNext()) {
                          RenovationBatchForm form = rbfl.getNextRenovationBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (rbfl.hasNext()) {
                          RenovationBatchForm[] forms = rbfl.getNextRenovationBatchForms(rbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextRenovationBatchForm
Description

Gets the next RenovationBatchForm in this list.

Returnosid.room.construction.batch.RenovationBatchFormthe next RenovationBatchForm in this list. The hasNext() method should be used to test that a next RenovationBatchForm is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextRenovationBatchForms
Description

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

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