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

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

                     
                     
                     while (pbfl.hasNext()) {
                          PriceBatchForm form = pbfl.getNextPriceBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pbfl.hasNext()) {
                          PriceBatchForm[] forms = pbfl.getNextPriceBatchForms(pbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextPriceBatchForm
Description

Gets the next PriceBatchForm in this list.

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

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

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