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

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

                     
                     
                     while (cbfl.hasNext()) {
                          CustomerBatchForm form = cbfl.getNextCustomerBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cbfl.hasNext()) {
                          CustomerBatchForm[] forms = cbfl.getNextCustomerBatchForms(cbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextCustomerBatchForm
Description

Gets the next CustomerBatchForm in this list.

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

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

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