org.osid.recipe

Interface RecipeList

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidList

public interface RecipeList
extends OsidList

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());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
Recipe	getNextRecipe() Gets the next Recipe in this list.
Recipe[]	getNextRecipes(long n) Gets the next set of Recipe elements in this list.

Methods inherited from interface org.osid.OsidList

available, hasNext, skip

Methods inherited from interface org.osid.binding.java.OsidList

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getNextRecipe

Recipe getNextRecipe()
                     throws OperationFailedException

Gets the next Recipe in this list.

Returns:

the next Recipe in this list. The hasNext() method should be used to test that a next Recipe is available before calling this method.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getNextRecipes

Recipe[] getNextRecipes(long n)
                        throws OperationFailedException

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

Parameters:

n - the number of Recipe elements requested which must be less than or equal to available()

Returns:

an array of Recipe elements. The length of the array is less than or equal to the number specified.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.