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

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

                     
                     
                     while (fbfl.hasNext()) {
                          FloorBatchForm form = fbfl.getNextFloorBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (fbfl.hasNext()) {
                          FloorBatchForm[] forms = fbfl.getNextFloorBatchForms(fbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextFloorBatchForm
Description

Gets the next FloorBatchForm in this list.

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

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

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