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

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

                     
                     
                     while (rbfl.hasNext()) {
                          RoomBatchForm form = rbfl.getNextRoomBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (rbfl.hasNext()) {
                          RoomBatchForm[] forms = rbfl.getNextRoomBatchForms(rbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextRoomBatchForm
Description

Gets the next RoomBatchForm in this list.

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

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

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