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

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

                     
                     
                     while (cbfl.hasNext()) {
                          CookbookBatchForm form = cbfl.getNextCookbookBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cbfl.hasNext()) {
                          CookbookBatchForm[] forms = cbfl.getNextCookbookBatchForms(cbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextCookbookBatchForm
Description

Gets the next CookbookBatchForm in this list.

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

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

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