Interface RecipeSearch

All Superinterfaces:
Extensible, OsidCondition, OsidSearch, Suppliable
public interface RecipeSearch extends OsidSearch

The search interface for governing recipe searches.

  • Method Details

    • searchAmongRecipes

      void searchAmongRecipes(IdList recipeIds)
      Execute this search among the given list of recipes.
      Parameters:
      recipeIds - list of recipes
      Throws:
      NullArgumentException - recipeIds is null
      Compliance:
      mandatory - This method must be implemented.

    • orderRecipeResults

      void orderRecipeResults(RecipeSearchOrder recipeSearchOrder)
      Specify an ordering to the search results.
      Parameters:
      recipeSearchOrder - recipe search order
      Throws:
      NullArgumentException - recipeSearchOrder is null
      UnsupportedException - recipeSearchOrder is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getRecipeSearchRecord

      RecipeSearchRecord getRecipeSearchRecord(Type recipeSearchRecordType) throws OperationFailedException
      Gets the recipe search record corresponding to the given recipe search record Type. This method is used to retrieve an object implementing the requested record.
      Parameters:
      recipeSearchRecordType - a recipe search record type
      Returns:
      the recipe search record
      Throws:
      NullArgumentException - recipeSearchRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(recipeSearchRecordType) is false
      Compliance:
      mandatory - This method must be implemented.