org.osid.recipe.batch

Interface DirectionBatchAdminSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, DirectionAdminSession, OsidSession

public interface DirectionBatchAdminSession
extends DirectionAdminSession

This session creates, updates, and deletes Directions 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 Direction, a DirectionForm is requested using getDirectionFormsForCreate() specifying the desired recipes and record Types or none if no record Types are needed. Each of the returned DirectionForms 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 DirectionForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each DirectionForm corresponds to an attempted transaction.

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

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

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

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

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

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasDirections(AliasRequestList aliasRequests) Adds an Id to a Direction for the purpose of creating compatibility.
CreateResponseList	createDirections(DirectionBatchFormList directionForms) Creates a new set of Directions.
CreateResponseList	createIngredients(IngredientBatchFormList ingredientForms) Creates a new set of Ingredients.
DeleteResponseList	deleteAllDirections() Deletes all Directions in this Cookbook .
DeleteResponseList	deleteAllIngredients() Deletes all Ingredients in this Cookbook .
DeleteResponseList	deleteDirections(IdList directionIds) Deletes directions for the given Ids.
DeleteResponseList	deleteDirectionsForRecipe(Id recipeId) Deletes directions for the given recipe.
DeleteResponseList	deleteIngredients(IdList ingredientsIds) Deletes ingredients for the given Ids.
DeleteResponseList	deleteIngredientsForDirection(Id directionId) Deletes ingredients for the given direction.
DirectionBatchFormList	getDirectionFormsForCreate(IdList recipieIds, Type[] directionRecordTypes) Gets the direction forms for creating a bunch of new directions.
DirectionBatchFormList	getDirectionFormsForUpdate(IdList directionIds) Gets the direction forms for updating an existing set of directions.
IngredientBatchFormList	getIngredientFormsForCreate(IdList directionIds, Type[] ingredientRecordTypes) Gets the ingredient forms for creating a bunch of new ingredients.
IngredientBatchFormList	getIngredientFormsForUpdate(IdList ingredientIds) Gets the ingredient forms for updating an existing set of ingredients.
UpdateResponseList	updateDirections(DirectionBatchFormList directionForms) Updates existing directions.
UpdateResponseList	updateIngredients(IngredientBatchFormList ingredientForms) Updates existing ingredients.

Methods inherited from interface org.osid.recipe.DirectionAdminSession

aliasDirection, canCreateDirections, canCreateDirectionWithRecordTypes, canCreateIngredientWithRecordTypes, canDeleteDirections, canManageDirectionAliases, canManageIngredients, canSequenceDirections, canUpdateDirections, createDirection, createIngredient, deleteDirection, deleteIngredient, getCookbook, getCookbookId, getDirectionFormForCreate, getDirectionFormForUpdate, getIngredientFormForCreate, getIngredientFormForUpdate, moveDirectionAhead, moveDirectionBehind, orderDirections, updateDirection, updateIngredient

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getDirectionFormsForCreate

DirectionBatchFormList getDirectionFormsForCreate(IdList recipieIds,
                                                Type[] directionRecordTypes)
                                                  throws NotFoundException,
                                                         OperationFailedException,
                                                         PermissionDeniedException

Gets the direction forms for creating a bunch of new directions. A form is returned for each supplied recipe.

Parameters:

recipieIds - a list of recipe Ids

directionRecordTypes - array of direction record types to be included in each create operation or an empty list if none

Returns:

the direction forms

Throws:

NotFoundException - a recipieId is not found

NullArgumentException - recipeIds or directionRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createDirections

CreateResponseList createDirections(DirectionBatchFormList directionForms)
                                    throws OperationFailedException,
                                           PermissionDeniedException

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

Parameters:

directionForms - the direction forms

Returns:

the create responses

Throws:

NullArgumentException - directionForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDirectionFormsForUpdate

DirectionBatchFormList getDirectionFormsForUpdate(IdList directionIds)
                                                  throws NotFoundException,
                                                         OperationFailedException,
                                                         PermissionDeniedException

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

Parameters:

directionIds - the Ids of the Directions

Returns:

the direction forms

Throws:

NotFoundException - a directionId is not found

NullArgumentException - directionIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateDirections

UpdateResponseList updateDirections(DirectionBatchFormList directionForms)
                                    throws OperationFailedException,
                                           PermissionDeniedException

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 BatchCreateResponse .

Parameters:

directionForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - directionForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllDirections

DeleteResponseList deleteAllDirections()
                                       throws OperationFailedException,
                                              PermissionDeniedException

Deletes all Directions in this Cookbook .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteDirections

DeleteResponseList deleteDirections(IdList directionIds)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Deletes directions for the given Ids.

Parameters:

directionIds - the Ids of the directions to delete

Returns:

the delete responses

Throws:

NullArgumentException - directionIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteDirectionsForRecipe

DeleteResponseList deleteDirectionsForRecipe(Id recipeId)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

Deletes directions for the given recipe.

Parameters:

recipeId - the Id of a recipe

Returns:

the delete responses

Throws:

NullArgumentException - recipeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasDirections

AliasResponseList aliasDirections(AliasRequestList aliasRequests)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getIngredientFormsForCreate

IngredientBatchFormList getIngredientFormsForCreate(IdList directionIds,
                                                  Type[] ingredientRecordTypes)
                                                    throws NotFoundException,
                                                           OperationFailedException,
                                                           PermissionDeniedException

Gets the ingredient forms for creating a bunch of new ingredients. A form is returned for each supplied recipe.

Parameters:

directionIds - a list of direction Ids

ingredientRecordTypes - array of ingredient record types to be included in each create operation or an empty list if none

Returns:

the ingredient forms

Throws:

NotFoundException - a directionId is not found

NullArgumentException - directionIds or ingredientRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createIngredients

CreateResponseList createIngredients(IngredientBatchFormList ingredientForms)
                                     throws OperationFailedException,
                                            PermissionDeniedException

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

Parameters:

ingredientForms - the ingredient forms

Returns:

the create responses

Throws:

NullArgumentException - ingredientForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getIngredientFormsForUpdate

IngredientBatchFormList getIngredientFormsForUpdate(IdList ingredientIds)
                                                    throws NotFoundException,
                                                           OperationFailedException,
                                                           PermissionDeniedException

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

Parameters:

ingredientIds - the Ids of the Ingredients

Returns:

the ingredient forms

Throws:

NotFoundException - an ingredientId is not found

NullArgumentException - ingredientIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateIngredients

UpdateResponseList updateIngredients(IngredientBatchFormList ingredientForms)
                                     throws OperationFailedException,
                                            PermissionDeniedException

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 BatchCreateResponse .

Parameters:

ingredientForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - ingredientForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllIngredients

DeleteResponseList deleteAllIngredients()
                                        throws OperationFailedException,
                                               PermissionDeniedException

Deletes all Ingredients in this Cookbook .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteIngredients

DeleteResponseList deleteIngredients(IdList ingredientsIds)
                                     throws OperationFailedException,
                                            PermissionDeniedException

Deletes ingredients for the given Ids.

Parameters:

ingredientsIds - the Ids of the ingredients to delete

Returns:

the delete responses

Throws:

NullArgumentException - ingredientIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteIngredientsForDirection

DeleteResponseList deleteIngredientsForDirection(Id directionId)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

Deletes ingredients for the given direction.

Parameters:

directionId - the Id of a direction

Returns:

the delete responses

Throws:

NullArgumentException - directionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.