OSID Logo
OSID Specifications
logging batch package
Version 3.1.0
Interfaceosid.logging.batch.LogBatchFormList
Implementsosid.OsidList
Used Byosid.logging.batch.LogBatchAdminSession
Description

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

while (lbfl.hasNext()) {
     LogBatchForm form = lbfl.getNextLogBatchForm();
}
                
or
while (lbfl.hasNext()) {
     LogBatchForm[] forms = lbfl.getNextLogBatchForms(lbfl.available());
}
                
MethodgetNextLogBatchForm
Description

Gets the next LogBatchForm in this list.

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

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

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