Interface RecipeSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface RecipeSearch
extends OsidSearch

The search interface for governing recipe searches.

Method Summary

Modifier and Type	Method	Description
RecipeSearchRecord	getRecipeSearchRecord(Type recipeSearchRecordType)	Gets the recipe search record corresponding to the given recipe search record Type.
void	orderRecipeResults(RecipeSearchOrder recipeSearchOrder)	Specify an ordering to the search results.
void	searchAmongRecipes(IdList recipeIds)	Execute this search among the given list of recipes.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

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,
PermissionDeniedException

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

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(recipeSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.