OSID Logo
OSID Specifications
acknowledgement batch package
Version 3.1.0
Interfaceosid.acknowledgement.batch.BillingBatchFormList
Implementsosid.OsidList
Used Byosid.acknowledgement.batch.BillingBatchAdminSession
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.BillingBatchForm the next BillingBatchForm in this list. The hasNext() method should be used to test that a next BillingBatchForm 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.
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().

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