OSID Logo
OSID Specifications
recipe batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recipe.batch.RecipeBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (rbfl.hasNext()) {
                          RecipeBatchForm form = rbfl.getNextRecipeBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (rbfl.hasNext()) {
                          RecipeBatchForm[] forms = rbfl.getNextRecipeBatchForms(rbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextRecipeBatchForm
Description

Gets the next RecipeBatchForm in this list.

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

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

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