OSID Logo
OSID Specifications
topology batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.topology.batch.EdgeBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (ebfl.hasNext()) {
                          EdgeBatchForm form = ebfl.getNextEdgeBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ebfl.hasNext()) {
                          EdgeBatchForm[] forms = ebfl.getNextEdgeBatchForms(ebfl.available());
                     }
                     
                                 
                     
                
MethodgetNextEdgeBatchForm
Description

Gets the next EdgeBatchForm in this list.

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

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

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