OSID Logo
OSID Specifications
logging batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.logging.batch.LogEntryBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (lebfl.hasNext()) {
                          LogEntryBatchForm form = lebfl.getNextLogEntryBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (lebfl.hasNext()) {
                          LogEntryBatchForm[] forms = lebfl.getNextLogEntryBatchForms(lebfl.available());
                     }
                     
                                 
                     
                
MethodgetNextLogEntryBatchForm
Description

Gets the next LogEntryBatchForm in this list.

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

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

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