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

This session provides methods for searching Cookbook objects. The search query is constructed using the CookbookQuery. The cook book record Type also specifies the record for the cook book 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
CompliancemandatoryThis method must be implemented.
MethodgetCookbookQuery
Description

Gets a cook book query.

Returnosid.recipe.CookbookQuerythe cook book query
CompliancemandatoryThis method must be implemented.
MethodgetCookbooksByQuery
Description

Gets a list of Cookbooks matching the given search.

Parametersosid.recipe.CookbookQuerycookbookQuerythe cook book query
Returnosid.recipe.CookbookListthe returned CookbookList
ErrorsNULL_ARGUMENT cookbookQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED cookbookQuery is not of this service
CompliancemandatoryThis method must be implemented.