OSID Logo
OSID Specifications
journaling batch package
Version 3.1.0
Interfaceosid.journaling.batch.JournalEntryBatchFormList
Implementsosid.OsidList
Used Byosid.journaling.batch.JournalEntryBatchAdminSession
Description

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

while (jebfl.hasNext()) {
     JournalEntryBatchForm form = jebfl.getNextJournalEntryBatchForm();
}
                
or
while (jebfl.hasNext()) {
     JournalEntryBatchForm[] forms = jebfl.getNextJournalEntryBatchForms(jebfl.available());
}
                
MethodgetNextJournalEntryBatchForm
Description

Gets the next JournalEntryBatchForm in this list.

Returnosid.journaling.batch.JournalEntryBatchForm the next JournalEntryBatchForm in this list. The hasNext() method should be used to test that a next JournalEntryBatchForm 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.
MethodgetNextJournalEntryBatchForms
Description

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

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