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

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