OSID Logo
OSID Specifications
resourcing batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.batch.WorkBatchFormList
Implementsosid.OsidList
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.WorkBatchFormthe next WorkBatchForm in this list. The hasNext() method should be used to test that a next WorkBatchForm is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis 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().

Parameterscardinalnthe 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_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.