OSID Logo
OSID Specifications
ordering batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ordering.batch.ProductBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (pbfl.hasNext()) {
                          ProductBatchForm form = pbfl.getNextProductBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pbfl.hasNext()) {
                          ProductBatchForm[] forms = pbfl.getNextProductBatchForms(pbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextProductBatchForm
Description

Gets the next ProductBatchForm in this list.

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

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

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