OSID Logo
OSID Specifications
workflow batch package
Version 3.1.0
Interfaceosid.workflow.batch.ProcessBatchFormList
Implementsosid.OsidList
Used Byosid.workflow.batch.ProcessBatchAdminSession
Description

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

while (pbfl.hasNext()) {
     ProcessBatchForm form = pbfl.getNextProcessBatchForm();
}
                
or
while (pbfl.hasNext()) {
     ProcessBatchForm[] forms = pbfl.getNextProcessBatchForms(pbfl.available());
}
                
MethodgetNextProcessBatchForm
Description

Gets the next ProcessBatchForm in this list.

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

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

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