OSID Specifications
recipe package
Version 3.0.0
recipe package
Version 3.0.0
| Interface | osid.recipe.CookbookHierarchyDesignSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Used By | osid.recipe.RecipeManager | ||
osid.recipe.RecipeProxyManager | |||
| Description |
This session manages a hierarchy of cookbooks. Cookbooks
may be organized into a hierarchy for organizing or
federating. A parent | ||
| Method | getCookbookHierarchyId | ||
| Description |
Gets the hierarchy | ||
| Return | osid.id.Id | the hierarchy Id associated with this session | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCookbookHierarchy | ||
| Description |
Gets the hierarchy associated with this session. | ||
| Return | osid.hierarchy.Hierarchy | the hierarchy associated with this session | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canModifyCookbookHierarchy | ||
| 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 | ||
| Return | boolean | false if changing this hierarchy is not authorized,
true otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | addRootCookbook | ||
| Description |
Adds a root cookbook. | ||
| Parameters | osid.id.Id | cookbookId | the Id of a cookbook |
| Errors | ALREADY_EXISTS | cookbookId is already in hierarchy | |
| NOT_FOUND | cookbookId is not found | ||
| NULL_ARGUMENT | cookbookId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeRootCookbook | ||
| Description |
Removes a root cookbook. | ||
| Parameters | osid.id.Id | cookbookId | the Id of a cookbook |
| Errors | NOT_FOUND | cookbookId is not a root | |
| NULL_ARGUMENT | cookbookId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | addChildCookbook | ||
| Description |
Adds a child to a cookbook. | ||
| Parameters | osid.id.Id | cookbookId | the Id of a cookbook |
osid.id.Id | childId | the Id of the new child | |
| Errors | ALREADY_EXISTS | cookbookId is already a parent of childId | |
| NOT_FOUND | cookbookId or childId not found | ||
| NULL_ARGUMENT | cookbookId or childId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeChildCookbook | ||
| Description |
Removes a child from a cookbook. | ||
| Parameters | osid.id.Id | cookbookId | the Id of a cookbook |
osid.id.Id | childId | the Id of the new child | |
| Errors | NOT_FOUND | cookbookId not a parent of childId | |
| NULL_ARGUMENT | cookbookId or childId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeChildCookbooks | ||
| Description |
Removes all children from a cookbook. | ||
| Parameters | osid.id.Id | cookbookId | the Id of a cookbook |
| Errors | NOT_FOUND | cookbookId not found | |
| NULL_ARGUMENT | cookbookId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |