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

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

                     
                     
                     while (rl.hasNext()) {
                          Recipe recipe = rl.getNextRecipe();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (rl.hasNext()) {
                          Recipe[] recipes = rl.getNextRecipes(rl.available());
                     }
                     
                                 
                     
                
MethodgetNextRecipe
Description

Gets the next Recipe in this list.

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

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

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