Interface | osid.recipe.batch.DirectionBatchAdminSession | ||
---|---|---|---|
Implements | osid.recipe.DirectionAdminSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a The Once a batch of For updates, Once a batch of The delete operations delete | ||
Method | getDirectionFormsForCreate | ||
Description |
Gets the direction forms for creating a bunch of new directions. A form is returned for each supplied recipe. | ||
Parameters | osid.id.IdList | recipieIds | a list of recipe Ids |
osid.type.Type[] | directionRecordTypes | array of direction record types to be included in each create operation or an empty list if none | |
Return | osid.recipe.batch.DirectionBatchFormList | the direction forms | |
Errors | NOT_FOUND | a recipieId is not found | |
NULL_ARGUMENT | recipeIds or directionRecordTypes is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to request forms with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createDirections | ||
Description |
Creates a new set of | ||
Parameters | osid.recipe.batch.DirectionBatchFormList | directionForms | the direction forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | directionForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDirectionFormsForUpdate | ||
Description |
Gets the direction forms for updating an existing set of directions. A new direction form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | directionIds | the Ids of the Directions |
Return | osid.recipe.batch.DirectionBatchFormList | the direction forms | |
Errors | NOT_FOUND | a directionId is not found | |
NULL_ARGUMENT | directionIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateDirections | ||
Description |
Updates existing directions. This method returns an
error if the entire operation fails. Otherwise, the status
of an individual update operation is indicated in the
| ||
Parameters | osid.recipe.batch.DirectionBatchFormList | directionForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | directionForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllDirections | ||
Description |
Deletes all | ||
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteDirections | ||
Description |
Deletes directions for the given | ||
Parameters | osid.id.IdList | directionIds | the Ids of the directions to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | directionIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteDirectionsForRecipe | ||
Description |
Deletes directions for the given recipe. | ||
Parameters | osid.id.Id | recipeId | the Id of a recipe |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | recipeId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasDirections | ||
Description |
Adds an | ||
Parameters | osid.transaction.batch.AliasRequestList | aliasRequests | the alias requests |
Return | osid.transaction.batch.AliasResponseList | the alias responses | |
Errors | NULL_ARGUMENT | aliasRequests is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getIngredientFormsForCreate | ||
Description |
Gets the ingredient forms for creating a bunch of new ingredients. A form is returned for each supplied recipe. | ||
Parameters | osid.id.IdList | directionIds | a list of direction Ids |
osid.type.Type[] | ingredientRecordTypes | array of ingredient record types to be included in each create operation or an empty list if none | |
Return | osid.recipe.batch.IngredientBatchFormList | the ingredient forms | |
Errors | NOT_FOUND | a directionId is not found | |
NULL_ARGUMENT | directionIds or ingredientRecordTypes is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to request forms with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createIngredients | ||
Description |
Creates a new set of | ||
Parameters | osid.recipe.batch.IngredientBatchFormList | ingredientForms | the ingredient forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | ingredientForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getIngredientFormsForUpdate | ||
Description |
Gets the ingredient forms for updating an existing set of ingredients. A new ingredient form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | ingredientIds | the Ids of the Ingredients |
Return | osid.recipe.batch.IngredientBatchFormList | the ingredient forms | |
Errors | NOT_FOUND | an ingredientId is not found | |
NULL_ARGUMENT | ingredientIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateIngredients | ||
Description |
Updates existing ingredients. This method returns an
error if the entire operation fails. Otherwise, the status
of an individual update operation is indicated in the
| ||
Parameters | osid.recipe.batch.IngredientBatchFormList | ingredientForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | ingredientForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllIngredients | ||
Description |
Deletes all | ||
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteIngredients | ||
Description |
Deletes ingredients for the given | ||
Parameters | osid.id.IdList | ingredientsIds | the Ids of the ingredients to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | ingredientIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteIngredientsForDirection | ||
Description |
Deletes ingredients for the given direction. | ||
Parameters | osid.id.Id | directionId | the Id of a direction |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | directionId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |