Interface | osid.recipe.IngredientList | ||
---|---|---|---|
Implements | osid.OsidList | ||
Description |
Like all while (il.hasNext()) { Ingredient ingredient = il.getNextIngredient(); }or while (il.hasNext()) { Ingredient[] ingredients = il.getNextIngredients(il.available()); } | ||
Method | getNextIngredient | ||
Description |
Gets the next | ||
Return | osid.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. | |
Errors | ILLEGAL_STATE | no more elements available in this list | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getNextIngredients | ||
Description |
Gets the next set of | ||
Parameters | cardinal | n | the number of Ingredient elements requested which must be
less than or equal to available() |
Return | osid.recipe.Ingredient[] | an array of Ingredient elements. The length
of the array is less than or equal to the number specified. | |
Errors | ILLEGAL_STATE | no more elements available in this list | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. |