OSID Logo
OSID Specifications
resourcing batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.batch.FoundryBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (fbfl.hasNext()) {
                          FoundryBatchForm form = fbfl.getNextFoundryBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (fbfl.hasNext()) {
                          FoundryBatchForm[] forms = fbfl.getNextFoundryBatchForms(fbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextFoundryBatchForm
Description

Gets the next FoundryBatchForm in this list.

Returnosid.resourcing.batch.FoundryBatchFormthe next FoundryBatchForm in this list. The hasNext() method should be used to test that a next FoundryBatchForm is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextFoundryBatchForms
Description

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

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