OSID Logo
OSID Specifications
offering batch package
Version 3.1.0
Interfaceosid.offering.batch.ResultBatchFormList
Implementsosid.OsidList
Used Byosid.offering.batch.ResultBatchAdminSession
Description

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

while (rbfl.hasNext()) {
     ResultBatchForm form = rbfl.getNextResultBatchForm();
}
                
or
while (rbfl.hasNext()) {
     ResultBatchForm[] forms = rbfl.getNextResultBatchForms(abfl.available());
}
                
MethodgetNextResultBatchForm
Description

Gets the next ResultBatchForm in this list.

Returnosid.offering.batch.ResultBatchForm the next ResultBatchForm in this list. The hasNext() method should be used to test that a next ResultBatchForm 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.
MethodgetNextResultBatchForms
Description

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

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