OSID Logo
OSID Specifications
inquiry batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inquiry.batch.ResponseBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (rbfl.hasNext()) {
                          ResponseBatchForm form = rbfl.getNextResponseBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (rbfl.hasNext()) {
                          ResponseBatchForm[] forms = rbfl.getNextResponseBatchForms(rbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextResponseBatchForm
Description

Gets the next ResponseBatchForm in this list.

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

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

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