OSID Logo
OSID Specifications
control batch package
Version 3.1.0
Interfaceosid.control.batch.SystemBatchFormList
Implementsosid.OsidList
Used Byosid.control.batch.SystemBatchAdminSession
Description

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

while (sbfl.hasNext()) {
     SystemBatchForm form = sbfl.getNextSystemBatchForm();
}
                
or
while (sbfl.hasNext()) {
     SystemBatchForm[] forms = sbfl.getNextSystemBatchForms(sbfl.available());
}
                
MethodgetNextSystemBatchForm
Description

Gets the next SystemBatchForm in this list.

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

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

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