| Interface | osid.recipe.DirectionCookbookAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description | 
                 This session provides methods to re-assign   Adding a reference of a   | ||
| Method | canAssignDirections | ||
| Description | 
                     Tests if this user can alter direction/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 direction is not authorized,  true  
otherwise  | |
| Compliance | mandatory | This method must be implemented. | |
| Method | canAssignDirectionsToCookbook | ||
| Description | 
                     Tests if this user can alter direction/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 oubiliettes including and under the given cook book node in which any direction 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 | getAssignableCookbookIdsForDirection | ||
| Description | 
                     Gets a list of oubiliettes including and under the given cook book node in which a specific direction can be assigned.  | ||
| Parameters | osid.id.Id | cookbookId | the  Id  of the  Cookbook   | 
osid.id.Id | directionId | the  Id  of the  Direction   | |
| Return | osid.id.IdList | list of assignable cook book  Ids   | |
| Errors | NULL_ARGUMENT |  cookbookId  or  directionId  is  null 
  |                 |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignDirectionToCookbook | ||
| Description | 
                     Adds an existing   | ||
| Parameters | osid.id.Id | directionId | the  Id  of the  Direction   | 
osid.id.Id | cookbookId | the  Id  of the  Cookbook   | |
| Errors | ALREADY_EXISTS |  directionId  is already assigned to  cookbookId   |                 |
| NOT_FOUND |  directionId  or  cookbookId  not found  |                 ||
| NULL_ARGUMENT |  directionId  or  cookbookId  is  null 
  |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignDirectionFromCookbook | ||
| Description | 
                     Removes a   | ||
| Parameters | osid.id.Id | directionId | the  Id  of the  Direction   | 
osid.id.Id | cookbookId | the  Id  of the  Cookbook   | |
| Errors | NOT_FOUND |  directionId  or  cookbookId  not found or  
directionId  not assigned to  cookbookId   |                 |
| NULL_ARGUMENT |  directionId  or  cookbookId  is  null 
  |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |