OSID Logo
OSID Specifications
inquiry batch package
Version 3.1.0
Interfaceosid.inquiry.batch.ResponseBatchFormList
Implementsosid.OsidList
Used Byosid.inquiry.batch.ResponseBatchAdminSession
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.ResponseBatchForm the next ResponseBatchForm in this list. The hasNext() method should be used to test that a next ResponseBatchForm is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This 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().

Parameterscardinaln the 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_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.