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

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

                     
                     
                     while (lbfl.hasNext()) {
                          LocationBatchForm form = lbfl.getNextLocationBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (lbfl.hasNext()) {
                          LocationBatchForm[] forms = lbfl.getNextLocationBatchForms(lbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextLocationBatchForm
Description

Gets the next LocationBatchForm in this list.

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

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

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