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

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

                     
                     
                     while (cbfl.hasNext()) {
                          NodeBatchForm form = cbfl.getNextNodeBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cbfl.hasNext()) {
                          NodeBatchForm[] forms = cbfl.getNextNodeBatchForms(cbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextNodeBatchForm
Description

Gets the next NodeBatchForm in this list.

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

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

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