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

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

                     
                     
                     while (cbfl.hasNext()) {
                          CategoryBatchForm form = cbfl.getNextCategoryBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cbfl.hasNext()) {
                          CategoryBatchForm[] forms = cbfl.getNextCategoryBatchForms(cbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextCategoryBatchForm
Description

Gets the next CategoryBatchForm in this list.

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

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

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