OSID Logo
OSID Specifications
logging batch package
Version 3.1.0
Interfaceosid.logging.batch.LogEntryBatchFormList
Implementsosid.OsidList
Used Byosid.logging.batch.LogEntryBatchAdminSession
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.LogEntryBatchForm the next LogEntryBatchForm in this list. The hasNext() method should be used to test that a next LogEntryBatchForm 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.
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().

Parameterscardinaln the 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_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.