OSID Logo
OSID Specifications
journaling batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.journaling.batch.JournalBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (jbfl.hasNext()) {
                          JournalBatchForm form = jbfl.getNextJournalBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (jbfl.hasNext()) {
                          JournalBatchForm[] forms = jbfl.getNextJournalBatchForms(jbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextJournalBatchForm
Description

Gets the next JournalBatchForm in this list.

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

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

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