OSID Logo
OSID Specifications
control batch package
Version 3.1.0
Interfaceosid.control.batch.DeviceBatchFormList
Implementsosid.OsidList
Used Byosid.control.batch.DeviceBatchAdminSession
Description

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

while (dbfl.hasNext()) {
     DeviceBatchForm form = dbfl.getNextDeviceBatchForm();
}
                
or
while (dbfl.hasNext()) {
     DeviceBatchForm[] forms = dbfl.getNextDeviceBatchForms(dbfl.available());
}
                
MethodgetNextDeviceBatchForm
Description

Gets the next DeviceBatchForm in this list.

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

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

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