| Interface | osid.recipe.batch.RecipeBatchAdminSession | ||
|---|---|---|---|
| Implements | osid.recipe.RecipeAdminSession | ||
| 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 | getRecipeFormsForCreate | ||
| Description |
Gets the recipe forms for creating a bunch of new recipes. | ||
| Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | recipeRecordTypes | array of recipe record types to be included in each create operation or an empty list if none | |
| Return | osid.recipe.batch.RecipeBatchFormList | the recipe forms | |
| Errors | NULL_ARGUMENT | recipeRecordTypes 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 | createRecipes | ||
| Description |
Creates a new set of | ||
| Parameters | osid.recipe.batch.RecipeBatchFormList | recipeForms | the recipe forms |
| Return | osid.transaction.batch.CreateResponseList | the create responses | |
| Errors | NULL_ARGUMENT | recipeForms is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getRecipeFormsForUpdate | ||
| Description |
Gets the recipe forms for updating an existing set of recipes. A new recipe form should be requested for each update transaction. | ||
| Parameters | osid.id.IdList | recipeIds | the Ids of the Recipe |
| Return | osid.recipe.batch.RecipeBatchFormList | the recipe form | |
| Errors | NOT_FOUND | a recipeId is not found | |
| NULL_ARGUMENT | recipeIds is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | updateRecipes | ||
| Description |
Updates existing recipes. 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.RecipeBatchFormList | recipeForms | the form containing the elements to be updated |
| Return | osid.transaction.batch.UpdateResponseList | the update responses | |
| Errors | NULL_ARGUMENT | recipeForms is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteAllRecipes | ||
| 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 | deleteRecipes | ||
| Description |
Deletes recipes for the given | ||
| Parameters | osid.id.IdList | recipeIds | the Ids of the recipes to delete |
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT | recipeIds is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | aliasRecipes | ||
| 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. | |