OSID Logo
OSID Specifications
ordering batch package
Version 3.1.0
Interfaceosid.ordering.batch.PriceBatchFormList
Implementsosid.OsidList
Used Byosid.ordering.batch.PriceScheduleBatchAdminSession
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.PriceBatchForm the next PriceBatchForm in this list. The hasNext() method should be used to test that a next PriceBatchForm is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This 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().

Parameterscardinaln the 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_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.