OSID Logo
OSID Specifications
recipe batch package
Version 3.1.0
Interfaceosid.recipe.batch.RecipeBatchManager
Implementsosid.OsidManager
osid.recipe.batch.RecipeBatchProfile
Used Byosid.recipe.RecipeManager
Description

The recipe batch manager provides access to recipe batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

  • RecipeBatchAdminSession: a session to create, modify and delete Recipes in bulk
  • DirectionBatchAdminSession: a session to create, modify and delete Directions in bulk
  • ProcedureBatchAdminSession: a session to create, modify and delete Procedures in bulk
  • CookbookBatchAdminSession: a session to create, modify and delete Cookbook in bulk
MethodgetRecipeBatchAdminSession
Description

Gets the OsidSession associated with the bulk recipe administration service.

Returnosid.recipe.batch.RecipeBatchAdminSession a RecipeBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRecipeBatchAdmin() is false
Complianceoptional This method must be implemented if supportsRecipeBatchAdmin() is true.
MethodgetRecipeBatchAdminSessionForCookbook
Description

Gets the OsidSession associated with the bulk recipe administration service for the given cookbook.

Parametersosid.id.IdcookbookId the Id of the Cookbook
Returnosid.recipe.batch.RecipeBatchAdminSession a RecipeBatchAdminSession
ErrorsNOT_FOUND no Cookbook found by the given Id
NULL_ARGUMENT cookbookId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRecipeBatchAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsRecipeBatchAdmin() and supportsVisibleFederation() are true
MethodgetDirectionBatchAdminSession
Description

Gets the OsidSession associated with the bulk direction administration service.

Returnosid.recipe.batch.DirectionBatchAdminSession a DirectionBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsDirectionBatchAdmin() is false
Complianceoptional This method must be implemented if supportsDirectionBatchAdmin() is true.
MethodgetDirectionBatchAdminSessionForCookbook
Description

Gets the OsidSession associated with the bulk direction administration service for the given cookbook.

Parametersosid.id.IdcookbookId the Id of the Cookbook
Returnosid.recipe.batch.DirectionBatchAdminSession a DirectionBatchAdminSession
ErrorsNOT_FOUND no Cookbook found by the given Id
NULL_ARGUMENT cookbookId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsDirectionBatchAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsDirectionBatchAdmin() and supportsVisibleFederation() are true
MethodgetProcedureBatchAdminSession
Description

Gets the OsidSession associated with the bulk procedure administration service.

Returnosid.recipe.batch.ProcedureBatchAdminSession a ProcedureBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProcedureBatchAdmin() is false
Complianceoptional This method must be implemented if supportsProcedureBatchAdmin() is true.
MethodgetProcedureBatchAdminSessionForCookbook
Description

Gets the OsidSession associated with the bulk procedure administration service for the given cookbook.

Parametersosid.id.IdcookbookId the Id of the Cookbook
Returnosid.recipe.batch.ProcedureBatchAdminSession a ProcedureBatchAdminSession
ErrorsNOT_FOUND no Cookbook found by the given Id
NULL_ARGUMENT cookbookId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProcedureBatchAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsProcedureBatchAdmin() and supportsVisibleFederation() are true
MethodgetCookbookBatchAdminSession
Description

Gets the OsidSession associated with the bulk cookbook administration service.

Returnosid.recipe.batch.CookbookBatchAdminSession a CookbookBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCookbookBatchAdmin() is false
Complianceoptional This method must be implemented if supportsCookbookBatchAdmin() is true.