OSID Logo
OSID Specifications
financials posting batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.posting.batch.PostEntryBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (pbfl.hasNext()) {
                          PostEntryBatchForm form = pbfl.getNextPostEntryBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pbfl.hasNext()) {
                          PostEntryBatchForm[] forms = pbfl.getNextPostEntryBatchForms(pbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextPostEntryBatchForm
Description

Gets the next PostEntryBatchForm in this list.

Returnosid.financials.posting.batch.PostEntryBatchFormthe next PostEntryBatchForm in this list. The hasNext() method should be used to test that a next PostEntryBatchForm is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextPostEntryBatchForms
Description

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

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