OSID Logo
OSID Specifications
inventory batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inventory.batch.ModelBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (mbfl.hasNext()) {
                          ModelBatchForm form = mbfl.getNextModelBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (mbfl.hasNext()) {
                          ModelBatchForm[] forms = mbfl.getNextModelBatchForms(mbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextModelBatchForm
Description

Gets the next ModelBatchForm in this list.

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

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

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