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

This session provides methods to re-assign Recipes to Cookbook mappings. A Recipe may appear in multiple Cookbook objects and removing the last reference to a Recipe is the equivalent of deleting it. Each Cookbook may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a Recipe to another Cookbook is not a copy operation (eg: does not change its Id ).

MethodcanAssignRecipes
Description

Tests if this user can alter recipe/cook book mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 lookup operations to unauthorized users.

Returnboolean false if ingredient is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignRecipesToCookbook
Description

Tests if this user can alter recipe/cook book mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 lookup operations to unauthorized users.

Parametersosid.id.IdcookbookIdthe Id of the Cookbook
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT cookbookId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableCookbookIds
Description

Gets a list of cook books including and under the given cook book node in which any recipe can be assigned.

Parametersosid.id.IdcookbookIdthe Id of the Cookbook
Returnosid.id.IdListlist of assignable cook book Ids
ErrorsNULL_ARGUMENT cookbookId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableCookbookIdsForRecipe
Description

Gets a list of cook books including and under the given cook book node in which a specific recipe can be assigned.

Parametersosid.id.IdcookbookIdthe Id of the Cookbook
osid.id.IdrecipeIdthe Id of the Recipe
Returnosid.id.IdListlist of assignable cook book Ids
ErrorsNULL_ARGUMENT cookbookId or recipeId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignRecipeToCookbook
Description

Adds an existing Recipe to a Cookbook.

Parametersosid.id.IdrecipeIdthe Id of the Recipe
osid.id.IdcookbookIdthe Id of the Cookbook
ErrorsALREADY_EXISTS recipeId is not assigned to cookbookId
NOT_FOUND recipeId or cookbookId not found
NULL_ARGUMENT recipeId or cookbookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignRecipeFromCookbook
Description

Removes a Recipe from a Cookbook.

Parametersosid.id.IdrecipeIdthe Id of the Recipe
osid.id.IdcookbookIdthe Id of the Cookbook
ErrorsNOT_FOUND recipeId or cookbookId not found or recipeId not assigned to cookbookId
NULL_ARGUMENT recipeId or cookbookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.