Interface | osid.recipe.DirectionAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a For updates, The delete operations delete This session includes an | ||
Method | getCookbookId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Cookbook Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getCookbook | ||
Description |
Gets the | ||
Return | osid.recipe.Cookbook | the cookbook | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateDirections | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Direction creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateDirectionWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | directionRecordTypes | array of direction record types |
Return | boolean | true if Direction creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | directionRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getDirectionFormForCreate | ||
Description |
Gets the direction form for creating new directions. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | recipeId | a recipe Id |
osid.type.Type[] | directionRecordTypes | array of direction record types | |
Return | osid.recipe.DirectionForm | the direction form | |
Errors | NOT_FOUND | recipeId Is not found | |
NULL_ARGUMENT | recipeId or directionRecordTypes is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createDirection | ||
Description |
Creates a new | ||
Parameters | osid.recipe.DirectionForm | directionForm | the form for this Direction |
Return | osid.recipe.Direction | the new Direction | |
Errors | ILLEGAL_STATE | directionForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | directionForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | directionForm did not originate from
getDirectionFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateDirections | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Direction modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getDirectionFormForUpdate | ||
Description |
Gets the direction form for updating an existing direction. A new direction form should be requested for each update transaction. | ||
Parameters | osid.id.Id | directionId | the Id of the Direction |
Return | osid.recipe.DirectionForm | the direction form | |
Errors | NOT_FOUND | directionId is not found | |
NULL_ARGUMENT | directionId is null | ||
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateDirection | ||
Description |
Updates an existing direction. | ||
Parameters | osid.recipe.DirectionForm | directionForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | directionForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | directionForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | directionForm did not originate from
getDirectionFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteDirections | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Direction deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteDirection | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | directionId | the Id of the Direction to remove |
Errors | NOT_FOUND | directionId not found | |
NULL_ARGUMENT | directionId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageDirectionAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Direction aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasDirection | ||
Description |
Adds an | ||
Parameters | osid.id.Id | directionId | the Id of a Direction |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | directionId not found | ||
NULL_ARGUMENT | directionId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageIngredients | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Ingredient management is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateIngredientWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | ingredientRecordTypes | array of ingredient record types |
Return | boolean | true if Ingredient creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | ingredientRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getIngredientFormForCreate | ||
Description |
Gets the ingredient form for creating new ingredients. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | directionId | an ingredient Id |
osid.type.Type[] | ingredientRecordTypes | array of ingredient record types | |
Return | osid.recipe.IngredientForm | the ingredient form | |
Errors | NOT_FOUND | directionId Is not found | |
NULL_ARGUMENT | directionId or ingredientRecordTypes is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createIngredient | ||
Description |
Creates a new | ||
Parameters | osid.recipe.IngredientForm | ingredientForm | the form for this Ingredient |
Return | osid.recipe.Ingredient | the new Ingredient | |
Errors | ILLEGAL_STATE | ingredientForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | ingredientForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | ingredientForm did not originate from
geIngredientFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | getIngredientFormForUpdate | ||
Description |
Gets the ingredient form for updating an existing ingredient. A new ingredient form should be requested for each update transaction. | ||
Parameters | osid.id.Id | ingredientId | the Id of the Ingredient |
Return | osid.recipe.IngredientForm | the ingredient form | |
Errors | NOT_FOUND | ingredientId is not found | |
NULL_ARGUMENT | ingredientId is null | ||
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateIngredient | ||
Description |
Updates an existing ingredient. | ||
Parameters | osid.recipe.IngredientForm | ingredientForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | ingredientForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | ingredientForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | ingredientForm did not originate from
getIngredientFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteIngredient | ||
Description |
Deletes an | ||
Parameters | osid.id.Id | ingredientId | the Id of the Ingredient to remove |
Errors | NOT_FOUND | ingredientId not found | |
NULL_ARGUMENT | ingredientId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSequenceDirections | ||
Description |
Tests if this user can order | ||
Return | boolean | false if Direction ordering is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | moveDirectionAhead | ||
Description |
Reorders directions in a recipe by moving the specified direction in front of a reference direction. | ||
Parameters | osid.id.Id | directionId | the Id of a Direction |
osid.id.Id | recipeId | the Id of a Recipe | |
osid.id.Id | referenceId | the reference direction Id | |
Errors | NOT_FOUND | directionId, recipeId, or referenceId not
found or, directionId or referenceId not related
to recipeId | |
NULL_ARGUMENT | directionId, recipeId or referenceId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | moveDirectionBehind | ||
Description |
Reorders directions in a recipe by moving the specified direction behind a reference direction. | ||
Parameters | osid.id.Id | directionId | the Id of a Direction |
osid.id.Id | recipeId | the Id of a Recipe | |
osid.id.Id | referenceId | the reference direction Id | |
Errors | NOT_FOUND | directionId, recipeId, or referenceId not
found or, directionId or referenceId not related
to recipeId | |
NULL_ARGUMENT | directionId, recipeId or referenceId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | orderDirections | ||
Description |
Reorders a set of directions in a recipe. | ||
Parameters | osid.id.Id[] | directionIds | the Ids for a set of Directions |
osid.id.Id | recipeId | the Id of a Recipe | |
Errors | NOT_FOUND | recipeId not found or, a directionId not
related to recipeId | |
NULL_ARGUMENT | directionIds or recipeId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |