OSID Logo
OSID Specifications
resource batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resource.batch.ResourceBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (rbfl.hasNext()) {
                          ResourceBatchForm form = rbfl.getNextResourceBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (rbfl.hasNext()) {
                          ResourceBatchForm[] forms = rbfl.getNextResourceBatchForms(rbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextResourceBatchForm
Description

Gets the next ResourceBatchForm in this list.

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

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

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