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

This session manages queries and sequencing to create "smart" dynamic catalogs. A RecipeQuery can be retrieved from this session and mapped to this Cookbook to create a virtual collection of Recipes. The recipes may be sequenced using the RecipeSearchOrder from this session.

This Cookbook has a default query that matches any recipe and a default search order that specifies no sequencing. The queries may be examined using a RecipeQueryInspector. The query may be modified by converting the inspector back to a 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.
MethodcanManageSmartCookbooks
Description

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

Returnboolean false if smart cook book management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRecipeQuery
Description

Gets a recipe query.

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

Gets a recipe search order.

Returnosid.recipe.RecipeSearchOrderthe recipe search order
CompliancemandatoryThis method must be implemented.
MethodapplyRecipeQuery
Description

Applies a recipe query to this cookbook.

Parametersosid.recipe.RecipeQueryrecipeQuerythe recipe query
ErrorsNULL_ARGUMENT recipeQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED recipeQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectRecipeQuery
Description

Gets a recipe query inspector for this cookbook.

Returnosid.recipe.RecipeQueryInspectorthe recipe query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyRecipeSequencing
Description

Applies a recipe search order to this cookbook.

Parametersosid.recipe.RecipeSearchOrderrecipeSearchOrderthe recipe search order
ErrorsNULL_ARGUMENT recipeSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED recipeSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetRecipeQueryFromInspector
Description

Gets a recipe query from an inspector.

Parametersosid.recipe.RecipeQueryInspectorrecipeQueryInspectora recipe query inspector
Returnosid.recipe.RecipeQuerythe recipe query
ErrorsNULL_ARGUMENT recipeQueryInspector is null
UNSUPPORTED recipeQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.