org.osid.recipe

Interface RecipeQuerySession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

All Known Subinterfaces:

RecipeSearchSession

public interface RecipeQuerySession
extends OsidSession

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

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Methods

Modifier and Type	Method and 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.

Methods inherited from interface org.osid.OsidSession

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

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

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getCookbookId

Id getCookbookId()

Gets the Cookbook Id associated with this session.

Returns:

the Cookbook Id associated with this session

Compliance:

mandatory - This method must be implemented.

getCookbook

Cookbook getCookbook()
                     throws OperationFailedException,
                            PermissionDeniedException

Gets the Cookbook associated with this session.

Returns:

the cookbook

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSearchRecipes

boolean canSearchRecipes()

Tests if this user can perform Recipe lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedCookbookView

void useFederatedCookbookView()

Federates the view for methods in this session. A federated view will include recipes in cook book which are children of this cook book in the cook book hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedCookbookView

void useIsolatedCookbookView()

Isolates the view for methods in this session. An isolated view restricts searches to this cook book only.

Compliance:

mandatory - This method is must be implemented.

getRecipeQuery

RecipeQuery getRecipeQuery()

Gets a recipe query.

Returns:

the recipe query

Compliance:

mandatory - This method must be implemented.

getRecipesByQuery

RecipeList getRecipesByQuery(RecipeQuery recipeQuery)
                             throws OperationFailedException,
                                    PermissionDeniedException

Gets a list of Recipes matching the given recipe query.

Parameters:

recipeQuery - the recipe query

Returns:

the returned RecipeList

Throws:

NullArgumentException - recipeQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - recipeQuery is not of this service

Compliance:

mandatory - This method must be implemented.