Interface RecipeSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, RecipeQuerySession

public interface RecipeSearchSession
extends RecipeQuerySession

This session provides methods for searching among Recipe objects. The search query is constructed using the RecipeQuery.

getRecipesByQuery() is the basic search method and returns a list of Recipes. A more advanced search may be performed with getRecipesBySearch().It accepts a RecipeSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getRecipesBySearch() returns a RecipeSearchResults that can be used to access the resulting RecipeList or be used to perform a search within the result set through RecipeSearch.

This session defines views that offer differing behaviors for searching.

• federated cookbook view: searches include recipes in cookbooks of which this cookbook is an ancestor in the cookbook hierarchy
• isolated cookbook view: searches are restricted to recipes in this cookbooks

Recipes may have a query record indicated by their respective record types. The query record is accessed via the RecipeQuery.

Method Summary

Modifier and Type	Method	Description
RecipeQuery	getRecipeQueryFromInspector(RecipeQueryInspector recipeQueryInspector)	Gets a recipe query from an inspector.
RecipeSearchResults	getRecipesBySearch(RecipeQuery recipeQuery, RecipeSearch recipeSearch)	Gets the search results matching the given search query using the given search.
RecipeSearch	getRecipeSearch()	Gets a recipe search.
RecipeSearchOrder	getRecipeSearchOrder()	Gets a recipe search order.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Methods inherited from interface RecipeQuerySession

canSearchRecipes, getCookbook, getCookbookId, getRecipeQuery, getRecipesByQuery, useFederatedCookbookView, useIsolatedCookbookView

Modifier and Type	Method	Description
boolean	canSearchRecipes()	Tests if this user can perform Recipe lookups.
Cookbook	getCookbook()	Gets the Cookbook associated with this session.
Id	getCookbookId()	Gets the Cookbook Id associated with this session.
RecipeQuery	getRecipeQuery()	Gets a recipe query.
RecipeList	getRecipesByQuery(RecipeQuery recipeQuery)	Gets a list of Recipes matching the given recipe query.
void	useFederatedCookbookView()	Federates the view for methods in this session.
void	useIsolatedCookbookView()	Isolates the view for methods in this session.

Method Details

getRecipeSearch

RecipeSearch getRecipeSearch()

Gets a recipe search.

Returns:

the recipe search

Compliance:

mandatory - This method must be implemented.

getRecipeSearchOrder

RecipeSearchOrder getRecipeSearchOrder()

Gets a recipe search order. The RecipeSearchOrder is supplied to a RecipeSearch to specify the ordering of results.

Returns:

the recipe search order

Compliance:

mandatory - This method must be implemented.

getRecipesBySearch

RecipeSearchResults getRecipesBySearch(RecipeQuery recipeQuery,
 RecipeSearch recipeSearch)
                                throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

recipeQuery - the recipe query

recipeSearch - the recipe search

Returns:

the recipe search results

Throws:

NullArgumentException - recipeQuery or recipeSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - recipeQuery or recipeSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getRecipeQueryFromInspector

RecipeQuery getRecipeQueryFromInspector(RecipeQueryInspector recipeQueryInspector)

Gets a recipe query from an inspector. The inspector is available from a RecipeSearchResults.

Parameters:

recipeQueryInspector - a recipe query inspector

Returns:

the recipe query

Throws:

NullArgumentException - recipeQueryInspector is null

UnsupportedException - recipeQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.