OSID Logo
OSID Specifications
resourcing batch package
Version 3.1.0
Interfaceosid.resourcing.batch.FoundryBatchFormList
Implementsosid.OsidList
Used Byosid.resourcing.batch.FoundryBatchAdminSession
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.FoundryBatchForm the next FoundryBatchForm in this list. The hasNext() method should be used to test that a next FoundryBatchForm 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.
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().

Parameterscardinaln the 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_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.