OSID Logo
OSID Specifications
recipe batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recipe.batch.RecipeBatchAdminSession
Implementsosid.recipe.RecipeAdminSession
Description

This session creates, updates, and deletes Recipes in bulk. The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create a Recipe, a RecipeForm is requested using getRecipeFormsForCreate() specifying the desired record Types or none if no record Types are needed. Each of the returned RecipeForms will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once a RecipeForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each RecipeForm corresponds to an attempted transaction.

The RecipeForms returned from getRecipeFormsForCreate() may be linked to the originating request through the peer Ids of the RecipeForm. In the case where there may be duplicates, any RecipeForm of the same peer Ids may be used for a create operation.

Once a batch of RecipeForms are submitted for create, a CreateResponse is returned for each RecipeForm, although the ordering is not defined. Only errors that pertain to the entire create operation are returned from createRecipes(), errors specific to an individual RecipeForm are indicated in the corresponding CreateResponse. CreateResponses may be linked to the originating RecipeForm through the RecipeForm Id .

For updates, RecipeForms are requested to the Recipe Id that is to be updated using getRecipeFormsForUpdate() where the reference Id in the RecipeForm may be used to link the request. Similarly, the RecipeForm has metadata about the data that can be updated and it can perform validation before submitting the update. The RecipeForm can only be used once for a successful update and cannot be reused.

Once a batch of RecipeForms are submitted for update, an UpdateResponse is returned for each RecipeForm, although the ordering is not defined. Only errors that pertain to the entire update operation are returned from updateRecipes(), errors specific to an individual RecipeForm are indicated in the corresponding UpdateResponse. UpdateResponses may be linked to the originating RecipeForm through the RecipeForm Id.

The delete operations delete Recipes in bulk. To unmap a Recipe from the current Cookbook, the RecipeCookbookAssignmentSession should be used. These delete operations attempt to remove the Recipe itself thus removing it from all known Cookbook catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetRecipeFormsForCreate
Description

Gets the recipe forms for creating a bunch of new recipes.

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]recipeRecordTypesarray of recipe record types to be included in each create operation or an empty list if none
Returnosid.recipe.batch.RecipeBatchFormListthe recipe forms
ErrorsNULL_ARGUMENT recipeRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateRecipes
Description

Creates a new set of Recipes. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parametersosid.recipe.batch.RecipeBatchFormListrecipeFormsthe recipe forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT recipeForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRecipeFormsForUpdate
Description

Gets the recipe forms for updating an existing set of recipes. A new recipe form should be requested for each update transaction.

Parametersosid.id.IdListrecipeIdsthe Ids of the Recipe
Returnosid.recipe.batch.RecipeBatchFormListthe recipe form
ErrorsNOT_FOUNDa recipeId is not found
NULL_ARGUMENT recipeIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateRecipes
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 BatchCreateResponse .

Parametersosid.recipe.batch.RecipeBatchFormListrecipeFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT recipeForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllRecipes
Description

Deletes all Recipes in this Cookbook .

Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteRecipes
Description

Deletes recipes for the given Ids.

Parametersosid.id.IdListrecipeIdsthe Ids of the recipes to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT recipeIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasRecipes
Description

Adds an Id to a Recipe for the purpose of creating compatibility. The primary Id of the Recipe is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another recipe, it is reassigned to the given recipe Id.

Parametersosid.transaction.batch.AliasRequestListaliasRequeststhe alias requests
Returnosid.transaction.batch.AliasResponseListthe alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.