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

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

                     
                     
                     while (gbfl.hasNext()) {
                          GraphBatchForm form = gbfl.getNextGraphBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (gbfl.hasNext()) {
                          GraphBatchForm[] forms = gbfl.getNextGraphBatchForms(gbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextGraphBatchForm
Description

Gets the next GraphBatchForm in this list.

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

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

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