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

This session manages a hierarchy of cook books. Cookbooks may be organized into a hierarchy for organizing or federating. A parent Cookbook includes all of the procedures of its children such that a single root node contains all of the procedures of the federation.

MethodgetCookbookHierarchyId
Description

Gets the hierarchy Id associated with this session.

Returnosid.id.Idthe hierarchy Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetCookbookHierarchy
Description

Gets the hierarchy associated with this session.

Returnosid.hierarchy.Hierarchythe hierarchy associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanModifyCookbookHierarchy
Description

Tests if this user can change the hierarchy. A return of true does not guarantee successful authorization. A return of false indicates that it is known performing any update will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer these operations to an unauthorized user.

Returnboolean false if changing this hierarchy is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaddRootCookbook
Description

Adds a root cookbook.

Parametersosid.id.IdcookbookIdthe Id of a cookbook
ErrorsALREADY_EXISTS cookbookId is already in hierarchy
NOT_FOUND cookbookId is not found
NULL_ARGUMENT cookbookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveRootCookbook
Description

Removes a root cookbook.

Parametersosid.id.IdcookbookIdthe Id of a cookbook
ErrorsNOT_FOUND cookbookId is not a root
NULL_ARGUMENT cookbookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaddChildCookbook
Description

Adds a child to a cookbook.

Parametersosid.id.IdcookbookIdthe Id of a cookbook
osid.id.IdchildIdthe Id of the new child
ErrorsALREADY_EXISTS cookbookId is already a parent of childId
NOT_FOUND cookbookId or childId not found
NULL_ARGUMENT cookbookId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildCookbook
Description

Removes a child from a cookbook.

Parametersosid.id.IdcookbookIdthe Id of a cookbook
osid.id.IdchildIdthe Id of the new child
ErrorsNOT_FOUND cookbookId not a parent of childId
NULL_ARGUMENT cookbookId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildCookbooks
Description

Removes all children from a cookbook.

Parametersosid.id.IdcookbookIdthe Id of a cookbook
ErrorsNOT_FOUND cookbookId not found
NULL_ARGUMENT cookbookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.