OSID Logo
OSID Specifications
control batch package
Version 3.1.0
Interfaceosid.control.batch.ControllerBatchFormList
Implementsosid.OsidList
Used Byosid.control.batch.ControllerBatchAdminSession
Description

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

while (cbfl.hasNext()) {
     ControllerBatchForm form = cbfl.getNextControllerBatchForm();
}
                
or
while (cbfl.hasNext()) {
     ControllerBatchForm[] forms = cbfl.getNextControllerBatchForms(cbfl.available());
}
                
MethodgetNextControllerBatchForm
Description

Gets the next ControllerBatchForm in this list.

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

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

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