OSID Logo
OSID Specifications
resourcing batch package
Version 3.1.0
Interfaceosid.resourcing.batch.WorkBatchFormList
Implementsosid.OsidList
Used Byosid.resourcing.batch.WorkBatchAdminSession
Description

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

while (wbfl.hasNext()) {
     WorkBatchForm form = wbfl.getNextWorkBatchForm();
}
                
or
while (wbfl.hasNext()) {
     WorkBatchForm[] forms = wbfl.getNextWorkBatchForms(wbfl.available());
}
                
MethodgetNextWorkBatchForm
Description

Gets the next WorkBatchForm in this list.

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

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

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