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

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

                     
                     
                     while (dbfl.hasNext()) {
                          DeedBatchForm form = dbfl.getNextDeedBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (dbfl.hasNext()) {
                          DeedBatchForm[] forms = dbfl.getNextDeedBatchForms(dbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextDeedBatchForm
Description

Gets the next DeedBatchForm in this list.

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

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

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