| Interface | osid.recipe.ProcedureCookbookAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides methods to re-assign Adding a reference of a | ||
| Method | canAssignProcedures | ||
| Description |
Tests if this user can alter procedure/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
| ||
| Return | boolean | false if mapping is not authorized, true
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | canAssignProceduresToCookbook | ||
| Description |
Tests if this user can alter procedure/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
| ||
| Parameters | osid.id.Id | cookbookId | the Id of the Cookbook |
| Return | boolean | false if mapping is not authorized, true
otherwise | |
| Errors | NULL_ARGUMENT | cookbookId is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableCookbookIds | ||
| Description |
Gets a list of cook books including and under the given cook book node in which any procedure can be assigned. | ||
| Parameters | osid.id.Id | cookbookId | the Id of the Cookbook |
| Return | osid.id.IdList | list of assignable cook book Ids | |
| Errors | NULL_ARGUMENT | cookbookId is null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableCookbookIdsForProcedure | ||
| Description |
Gets a list of cook books including and under the given cook book node in which a specific procedure can be assigned. | ||
| Parameters | osid.id.Id | cookbookId | the Id of the Cookbook |
osid.id.Id | procedureId | the Id of the Procedure | |
| Return | osid.id.IdList | list of assignable cook book Ids | |
| Errors | NULL_ARGUMENT | cookbookId or procedureId is null
| |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignProcedureToCookbook | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | procedureId | the Id of the Procedure |
osid.id.Id | cookbookId | the Id of the Cookbook | |
| Errors | ALREADY_EXISTS | procedureId is already assigned to cookbookId | |
| NOT_FOUND | procedureId or cookbookId not found | ||
| NULL_ARGUMENT | procedureId or cookbookId is null
| ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignProcedureFromCookbook | ||
| Description |
Removes a | ||
| Parameters | osid.id.Id | procedureId | the Id of the Procedure |
osid.id.Id | cookbookId | the Id of the Cookbook | |
| Errors | NOT_FOUND | procedureId or cookbookId not found or
proecdureId not assigned to cookbookId | |
| NULL_ARGUMENT | procedureId or cookbookId is null
| ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |