OSID Logo
OSID Specifications
billing batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.batch.ItemBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (ibfl.hasNext()) {
                          ItemBatchForm form = ibfl.getNextItemBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ibfl.hasNext()) {
                          ItemBatchForm[] forms = ibfl.getNextItemBatchForms(ibfl.available());
                     }
                     
                                 
                     
                
MethodgetNextItemBatchForm
Description

Gets the next ItemBatchForm in this list.

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

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

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