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

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

                     
                     
                     while (obfl.hasNext()) {
                          ObstacleBatchForm form = obfl.getNextObstacleBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (obfl.hasNext()) {
                          ObstacleBatchForm[] forms = obfl.getNextObstacleBatchForms(obfl.available());
                     }
                     
                                 
                     
                
MethodgetNextObstacleBatchForm
Description

Gets the next ObstacleBatchForm in this list.

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

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

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