OSID Logo
OSID Specifications
recipe package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recipe.RecipeQuerySession
Implementsosid.OsidSession
Description

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.

MethodgetCookbookId
Description

Gets the Cookbook Id associated with this session.

Returnosid.id.Idthe Cookbook Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetCookbook
Description

Gets the Cookbook associated with this session.

Returnosid.recipe.Cookbookthe cookbook
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSearchRecipes
Description

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.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedCookbookView
Description

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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedCookbookView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodgetRecipeQuery
Description

Gets a recipe query.

Returnosid.recipe.RecipeQuerythe recipe query
CompliancemandatoryThis method must be implemented.
MethodgetRecipesByQuery
Description

Gets a list of Recipes matching the given recipe query.

Parametersosid.recipe.RecipeQueryrecipeQuerythe recipe query
Returnosid.recipe.RecipeListthe returned RecipeList
ErrorsNULL_ARGUMENT recipeQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED recipeQuery is not of this service
CompliancemandatoryThis method must be implemented.