OSID Logo
OSID Specifications
mapping batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.batch.MapBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (mbfl.hasNext()) {
                          MapBatchForm form = mbfl.getNextMapBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (mbfl.hasNext()) {
                          MapBatchForm[] forms = mbfl.getNextMapBatchForms(mbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextMapBatchForm
Description

Gets the next MapBatchForm in this list.

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

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

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