OSID Logo
OSID Specifications
acknowledgement batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.acknowledgement.batch.BillingBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (fbfl.hasNext()) {
                          BillingBatchForm form = fbfl.getNextBillingBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (fbfl.hasNext()) {
                          BillingBatchForm[] forms = fbfl.getNextBillingBatchForms(fbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextBillingBatchForm
Description

Gets the next BillingBatchForm in this list.

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

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

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