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

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

                     
                     
                     while (sbfl.hasNext()) {
                          SpeedZoneBatchForm form = sbfl.getNextSpeedZoneBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (sbfl.hasNext()) {
                          SpeedZoneBatchForm[] forms = sbfl.getNextSpeedZoneBatchForms(sbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextSpeedZoneBatchForm
Description

Gets the next SpeedZoneBatchForm in this list.

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

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

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