OSID Logo
OSID Specifications
recipe package
Version 3.1.0
Interfaceosid.recipe.IngredientList
Implementsosid.OsidList
Used Byosid.recipe.Direction
Description

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

while (il.hasNext()) {
     Ingredient ingredient = il.getNextIngredient();
}
                
or
while (il.hasNext()) {
     Ingredient[] ingredients = il.getNextIngredients(il.available());
}
                
MethodgetNextIngredient
Description

Gets the next Ingredient in this list.

Returnosid.recipe.Ingredient the next Ingredient in this list. The hasNext() method should be used to test that a next Ingredient 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.
MethodgetNextIngredients
Description

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

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