Interface | osid.recipe.batch.RecipeBatchManager | ||
---|---|---|---|
Implements | osid.OsidManager | ||
osid.recipe.batch.RecipeBatchProfile | |||
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:
| ||
Method | getRecipeBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.recipe.batch.RecipeBatchAdminSession | a RecipeBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRecipeBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsRecipeBatchAdmin()
is true. | |
Method | getRecipeBatchAdminSessionForCookbook | ||
Description |
Gets the | ||
Parameters | osid.id.Id | cookbookId | the Id of the Cookbook |
Return | osid.recipe.batch.RecipeBatchAdminSession | a RecipeBatchAdminSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsRecipeBatchAdmin()
and supportsVisibleFederation() are true | |
Method | getDirectionBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.recipe.batch.DirectionBatchAdminSession | a DirectionBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsDirectionBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsDirectionBatchAdmin()
is true. | |
Method | getDirectionBatchAdminSessionForCookbook | ||
Description |
Gets the | ||
Parameters | osid.id.Id | cookbookId | the Id of the Cookbook |
Return | osid.recipe.batch.DirectionBatchAdminSession | a DirectionBatchAdminSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsDirectionBatchAdmin()
and supportsVisibleFederation() are true | |
Method | getProcedureBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.recipe.batch.ProcedureBatchAdminSession | a ProcedureBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProcedureBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsProcedureBatchAdmin()
is true. | |
Method | getProcedureBatchAdminSessionForCookbook | ||
Description |
Gets the | ||
Parameters | osid.id.Id | cookbookId | the Id of the Cookbook |
Return | osid.recipe.batch.ProcedureBatchAdminSession | a ProcedureBatchAdminSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsProcedureBatchAdmin()
and supportsVisibleFederation() are true | |
Method | getCookbookBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.recipe.batch.CookbookBatchAdminSession | a CookbookBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCookbookBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsCookbookBatchAdmin()
is true. |