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

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

                     
                     
                     while (psbfl.hasNext()) {
                          PriceScheduleBatchForm form = psbfl.getNextPriceScheduleBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (psbfl.hasNext()) {
                          PriceScheduleBatchForm[] forms = psbfl.getNextPriceScheduleBatchForms(psbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextPriceScheduleBatchForm
Description

Gets the next PriceScheduleBatchForm in this list.

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

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

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