OSID Logo
OSID Specifications
recipe package
Version 3.1.0
Interfaceosid.recipe.CookbookQuerySession
Implementsosid.OsidSession
Implemented Byosid.recipe.CookbookSearchSession
Used Byosid.recipe.RecipeManager
osid.recipe.RecipeProxyManager
Description

This session provides methods for searching Cookbook catalogs. The search query is constructed using the CookbookQuery. The cookbook record Type also specifies the record for the cookbook query.

Cookbooks may have a query record indicated by their respective record types. The query record is accessed via the CookbookQuery. The returns in this session may not be cast directly to these interfaces.

MethodcanSearchCookbooks
Description

Tests if this user can perform Cookbook searches. 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 opt not to offer search operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethodgetCookbookQuery
Description

Gets a cookbook query.

Returnosid.recipe.CookbookQuery the cookbook query
Compliancemandatory This method must be implemented.
MethodgetCookbooksByQuery
Description

Gets a list of Cookbooks matching the given search.

Parametersosid.recipe.CookbookQuerycookbookQuery the cookbook query
Returnosid.recipe.CookbookList the returned CookbookList
ErrorsNULL_ARGUMENT cookbookQuery is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED cookbookQuery is not of this service
Compliancemandatory This method must be implemented.