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

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

                     
                     
                     while (cbfl.hasNext()) {
                          CreditBatchForm form = cbfl.getNextCreditBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cbfl.hasNext()) {
                          CreditBatchForm[] forms = cbfl.getNextCreditBatchForms(cbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextCreditBatchForm
Description

Gets the next CreditBatchForm in this list.

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

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

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