Interface | osid.recipe.RecipeManager | ||
---|---|---|---|
Implements | osid.OsidManager | ||
osid.recipe.RecipeProfile | |||
Description |
The recipe manager provides access to procedure sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
| ||
Method | getRecipeLookupSession | ||
Description |
Gets the | ||
Return | osid.recipe.RecipeLookupSession | a RecipeLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRecipeLookup() is false | ||
Compliance | optional | This method must be implemented if supportsRecipeLookup() is
true. | |
Method | getRecipeLookupSessionForCookbook | ||
Description |
Gets the | ||
Parameters | osid.id.Id | cookbookId | the Id of the Cookbook |
Return | osid.recipe.RecipeLookupSession | q RecipeLookupSession | |
Errors | NOT_FOUND | no Cookbook found by the given Id | |
NULL_ARGUMENT | cookbookId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRecipeLookup() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsRecipeLookup()
and supportsVisibleFederation() are true | |
Method | getRecipeQuerySession | ||
Description |
Gets the | ||
Return | osid.recipe.RecipeQuerySession | a RecipeQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRecipeQuery() is false | ||
Compliance | optional | This method must be implemented if supportsRecipeQuery() is
true. | |
Method | getRecipeQuerySessionForCookbook | ||
Description |
Gets the | ||
Parameters | osid.id.Id | cookbookId | the Id of the Cookbook |
Return | osid.recipe.RecipeQuerySession | a RecipeQuerySession | |
Errors | NOT_FOUND | no cook book found by the given Id | |
NULL_ARGUMENT | cookbookId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRecipeQuery() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsRecipeQuery() and
supportsVisibleFederation() are true | |
Method | getRecipeSearchSession | ||
Description |
Gets the | ||
Return | osid.recipe.RecipeSearchSession | a RecipeSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRecipeSearch() is false | ||
Compliance | optional | This method must be implemented if supportsRecipeSearch() is
true. | |
Method | getRecipeSearchSessionForCookbook | ||
Description |
Gets the | ||
Parameters | osid.id.Id | cookbookId | the Id of the Cookbook |
Return | osid.recipe.RecipeSearchSession | a RecipeSearchSession | |
Errors | NOT_FOUND | no cook book found by the given Id | |
NULL_ARGUMENT | cookbookId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRecipeSearch() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsRecipeSearch()
and supportsVisibleFederation() are true | |
Method | getRecipeAdminSession | ||
Description |
Gets the | ||
Return | osid.recipe.RecipeAdminSession | a RecipeAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRecipeAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsRecipeAdmin() is
true. | |
Method | getRecipeAdminSessionForCookbook | ||
Description |
Gets the | ||
Parameters | osid.id.Id | cookbookId | the Id of the Cookbook |
Return | osid.recipe.RecipeAdminSession | a RecipeAdminSession | |
Errors | NOT_FOUND | no cook book found by the given Id | |
NULL_ARGUMENT | cookbookId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRecipeAdmin() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsRecipeAdmin() and
supportsVisibleFederation() are true | |
Method | getRecipeNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.recipe.RecipeReceiver | recipeReceiver | the notification callback |
Return | osid.recipe.RecipeNotificationSession | a RecipeNotificationSession | |
Errors | NULL_ARGUMENT | recipeReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRecipeNotification() is false | ||
Compliance | optional | This method must be implemented if supportsRecipeNotification()
is true. | |
Method | getRecipeNotificationSessionForCookbook | ||
Description |
Gets the | ||
Parameters | osid.recipe.RecipeReceiver | recipeReceiver | the notification callback |
osid.id.Id | cookbookId | the Id of the Cookbook | |
Return | osid.recipe.RecipeNotificationSession | a RecipeNotificationSession | |
Errors | NOT_FOUND | no cook book found by the given Id | |
NULL_ARGUMENT | recipeReceiver or cookbookId is null
| ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRecipeNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsRecipeNotification()
and supportsVisibleFederation() are true | |
Method | getRecipeCookbookSession | ||
Description |
Gets the | ||
Return | osid.recipe.RecipeCookbookSession | a RecipeCookbookSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRecipeCookbook() is false | ||
Compliance | optional | This method must be implemented if supportsRecipeCookbook()
is true. | |
Method | getRecipeCookbookAssignmentSession | ||
Description |
Gets the | ||
Return | osid.recipe.RecipeCookbookAssignmentSession | a RecipeCookbookAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRecipeCookbookAssignment() is false | ||
Compliance | optional | This method must be implemented if
supportsRecipeCookbookAssignment() is true. | |
Method | getRecipeSmartCookbookSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | cookbookId | the Id of the Cookbook |
Return | osid.recipe.RecipeSmartCookbookSession | a RecipeSmartCookbookSession | |
Errors | NOT_FOUND | no Cookbook found by the given Id | |
NULL_ARGUMENT | cookbookId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRecipeSmartCookbook() is false | ||
Compliance | optional | This method must be implemented if supportsRecipeSmartCookbook()
is true. | |
Method | getDirectionLookupSession | ||
Description |
Gets the | ||
Return | osid.recipe.DirectionLookupSession | a DirectionLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsDirectionLookup() is false | ||
Compliance | optional | This method must be implemented if supportsDirectionLookup()
is true. | |
Method | getDirectionLookupSessionForCookbook | ||
Description |
Gets the | ||
Parameters | osid.id.Id | cookbookId | the Id of the cook book |
Return | osid.recipe.DirectionLookupSession | a DirectionLookupSession | |
Errors | NOT_FOUND | no Cookbook found by the given Id | |
NULL_ARGUMENT | cookbookId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDirectionLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsDirectionLookup()
and supportsVisibleFederation() are true | |
Method | getDirectionQuerySession | ||
Description |
Gets the | ||
Return | osid.recipe.DirectionQuerySession | a DirectionQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsDirectionQuery() is false | ||
Compliance | optional | This method must be implemented if supportsDirectionQuery()
is true. | |
Method | getDirectionQuerySessionForCookbook | ||
Description |
Gets the | ||
Parameters | osid.id.Id | cookbookId | the Id of the Cookbook |
Return | osid.recipe.DirectionQuerySession | a DirectionQuerySession | |
Errors | NOT_FOUND | no cook book found by the given Id | |
NULL_ARGUMENT | cookbookId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDirectionQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsDirectionQuery()
and supportsVisibleFederation() are true | |
Method | getDirectionSearchSession | ||
Description |
Gets the | ||
Return | osid.recipe.DirectionSearchSession | a DirectionSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsDirectionSearch() is false | ||
Compliance | optional | This method must be implemented if supportsDirectionSearch()
is true. | |
Method | getDirectionSearchSessionForCookbook | ||
Description |
Gets the | ||
Parameters | osid.id.Id | cookbookId | the Id of the Cookbook |
Return | osid.recipe.DirectionSearchSession | a DirectionSearchSession | |
Errors | NOT_FOUND | no cook book found by the given Id | |
NULL_ARGUMENT | cookbookId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDirectionSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsDirectionSearch()
and supportsVisibleFederation() are true | |
Method | getDirectionAdminSession | ||
Description |
Gets the | ||
Return | osid.recipe.DirectionAdminSession | a DirectionAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsDirectionAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsDirectionAdmin()
is true. | |
Method | getDirectionAdminSessionForCookbook | ||
Description |
Gets the | ||
Parameters | osid.id.Id | cookbookId | the Id of the Cookbook |
Return | osid.recipe.DirectionAdminSession | a DirectionAdminSession | |
Errors | NOT_FOUND | no cook book found by the given Id | |
NULL_ARGUMENT | cookbookId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDirectionAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsDirectionAdmin()
and supportsVisibleFederation() are true | |
Method | getDirectionNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.recipe.DirectionReceiver | directionReceiver | the notification callback |
Return | osid.recipe.DirectionNotificationSession | a DirectionNotificationSession | |
Errors | NULL_ARGUMENT | directionReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDirectionNotification() is false | ||
Compliance | optional | This method must be implemented if supportsDirectionNotification()
is true. | |
Method | getDirectionNotificationSessionForCookbook | ||
Description |
Gets the | ||
Parameters | osid.recipe.DirectionReceiver | directionReceiver | the notification callback |
osid.id.Id | cookbookId | the Id of the Cookbook | |
Return | osid.recipe.DirectionNotificationSession | a DirectionNotificationSession | |
Errors | NOT_FOUND | no cook book found by the given Id | |
NULL_ARGUMENT | directionReceiver or cookbookId is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDirectionNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsDirectionNotification()
and supportsVisibleFederation() are true | |
Method | getDirectionCookbookSession | ||
Description |
Gets the | ||
Return | osid.recipe.DirectionCookbookSession | a DirectionCookbookSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsDirectionCookbook() is false | ||
Compliance | optional | This method must be implemented if supportsDirectionCookbook()
is true. | |
Method | getDirectionCookbookAssignmentSession | ||
Description |
Gets the | ||
Return | osid.recipe.DirectionCookbookAssignmentSession | a DirectionCookbookAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsDirectionCookbookAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsDirectionCookbookAssignment() is true. | |
Method | getDirectionSmartCookbookSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | cookbookId | the Id of the Cookbook |
Return | osid.recipe.DirectionSmartCookbookSession | a DirectionSmartCookbookSession | |
Errors | NOT_FOUND | no cook book found by the given Id | |
NULL_ARGUMENT | cookbookId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDirectionSmartCookbook() is false | ||
Compliance | optional | This method must be implemented if supportsDirectionSmartCookbook()
is true. | |
Method | getProcedureLookupSession | ||
Description |
Gets the | ||
Return | osid.recipe.ProcedureLookupSession | a ProcedureLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProcedureLookup() is false | ||
Compliance | optional | This method must be implemented if supportsProcedureLookup()
is true. | |
Method | getProcedureLookupSessionForCookbook | ||
Description |
Gets the | ||
Parameters | osid.id.Id | cookbookId | the Id of the Cookbook |
Return | osid.recipe.ProcedureLookupSession | a ProcedureLookupSession | |
Errors | NOT_FOUND | no Cookbook found by the given Id | |
NULL_ARGUMENT | cookbookId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProcedureLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsProcedureLookup()
and supportsVisibleFederation() are true | |
Method | getProcedureQuerySession | ||
Description |
Gets the | ||
Return | osid.recipe.ProcedureQuerySession | a ProcedureQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProcedureQuery() is false | ||
Compliance | optional | This method must be implemented if supportsProcedureQuery()
is true. | |
Method | getProcedureQuerySessionForCookbook | ||
Description |
Gets the | ||
Parameters | osid.id.Id | cookbookId | the Id of the Cookbook |
Return | osid.recipe.ProcedureQuerySession | a ProcedureQuerySession | |
Errors | NOT_FOUND | no Cookbook found by the given Id | |
NULL_ARGUMENT | cookbookId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProcedureQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsProcedureQuery()
and supportsVisibleFederation() are true | |
Method | getProcedureSearchSession | ||
Description |
Gets the | ||
Return | osid.recipe.ProcedureSearchSession | a ProcedureSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProcedureSearch() is false | ||
Compliance | optional | This method must be implemented if supportsProcedureSearch()
is true. | |
Method | getProcedureSearchSessionForCookbook | ||
Description |
Gets the | ||
Parameters | osid.id.Id | cookbookId | the Id of the Cookbook |
Return | osid.recipe.ProcedureSearchSession | a ProcedureSearchSession | |
Errors | NOT_FOUND | no Cookbook found by the given Id | |
NULL_ARGUMENT | cookbookId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProcedureSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsProcedureSearch()
and supportsVisibleFederation() are true | |
Method | getProcedureAdminSession | ||
Description |
Gets the | ||
Return | osid.recipe.ProcedureAdminSession | a ProcedureAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProcedureAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsProcedureAdmin()
is true. | |
Method | getProcedureAdminSessionForCookbook | ||
Description |
Gets the | ||
Parameters | osid.id.Id | cookbookId | the Id of the Cookbook |
Return | osid.recipe.ProcedureAdminSession | a ProcedureAdminSession | |
Errors | NOT_FOUND | no Cookbook found by the given Id | |
NULL_ARGUMENT | cookbookId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProcedureAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsProcedureAdmin()
and supportsVisibleFederation() are true | |
Method | getProcedureNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.recipe.ProcedureReceiver | procedureReceiver | the receiver |
Return | osid.recipe.ProcedureNotificationSession | a ProcedureNotificationSession | |
Errors | NULL_ARGUMENT | procedureReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProcedureNotification() is false | ||
Compliance | optional | This method must be implemented if supportsProcedureNotification()
is true. | |
Method | getProcedureNotificationSessionForCookbook | ||
Description |
Gets the | ||
Parameters | osid.recipe.ProcedureReceiver | procedureReceiver | the receiver |
osid.id.Id | cookbookId | the Id of the Cookbook | |
Return | osid.recipe.ProcedureNotificationSession | a ProcedureNotificationSession | |
Errors | NOT_FOUND | no Cookbook found by the given Id | |
NULL_ARGUMENT | procedureReceiver or cookbookId is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProcedureNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsProcedureNotification()
and supportsVisibleFederation() are true | |
Method | getProcedureCookbookSession | ||
Description |
Gets the session for retrieving procedure to cook book mappings. | ||
Return | osid.recipe.ProcedureCookbookSession | a ProcedureCookbookSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProcedureCookbook() is false | ||
Compliance | optional | This method must be implemented if supportsProcedureCookbook()
is true. | |
Method | getProcedureCookbookAssignmentSession | ||
Description |
Gets the session for assigning procedure to cook book mappings. | ||
Return | osid.recipe.ProcedureCookbookAssignmentSession | a ProcedureCookbookAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProcedureCookbookAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsProcedureCookbookAssignment() is true. | |
Method | getProcedureSmartCookbookSession | ||
Description |
Gets the session associated with the procedure smart cook book for the given cookbook. | ||
Parameters | osid.id.Id | cookbookId | the Id of the cookbook |
Return | osid.recipe.ProcedureSmartCookbookSession | a ProcedureSmartCookbookSession | |
Errors | NOT_FOUND | procedureBookId not found | |
NULL_ARGUMENT | procedureBookId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProcedureSmartCookbook() is false | ||
Compliance | optional | This method must be implemented if supportsProcedureSmartCookbook()
is true. | |
Method | getCookbookLookupSession | ||
Description |
Gets the | ||
Return | osid.recipe.CookbookLookupSession | a CookbookLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCookbookLookup() is false | ||
Compliance | optional | This method must be implemented if supportsCookbookLookup()
is true. | |
Method | getCookbookQuerySession | ||
Description |
Gets the | ||
Return | osid.recipe.CookbookQuerySession | a CookbookQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCookbookQuery() is false | ||
Compliance | optional | This method must be implemented if supportsCookbookQuery()
is true. | |
Method | getCookbookSearchSession | ||
Description |
Gets the | ||
Return | osid.recipe.CookbookSearchSession | a CookbookSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCookbookSearch() is false | ||
Compliance | optional | This method must be implemented if supportsCookbookSearch()
is true. | |
Method | getCookbookAdminSession | ||
Description |
Gets the | ||
Return | osid.recipe.CookbookAdminSession | a CookbookAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCookbookAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsCookbookAdmin()
is true. | |
Method | getCookbookNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.recipe.CookbookReceiver | cookbookReceiver | the receiver |
Return | osid.recipe.CookbookNotificationSession | a CookbookNotificationSession | |
Errors | NULL_ARGUMENT | cookbookReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCookbookNotification() is false | ||
Compliance | optional | This method must be implemented if supportsCookbookNotification()
is true. | |
Method | getCookbookHierarchySession | ||
Description |
Gets the | ||
Return | osid.recipe.CookbookHierarchySession | a CookbookHierarchySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCookbookHierarchy() is false | ||
Compliance | optional | This method must be implemented if supportsCookbookHierarchy()
is true. | |
Method | getCookbookHierarchyDesignSession | ||
Description |
Gets the | ||
Return | osid.recipe.CookbookHierarchyDesignSession | a CookbookHierarchyDesignSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCookbookHierarchyDesign() is false | ||
Compliance | optional | This method must be implemented if supportsCookbookHierarchyDesign()
is true. | |
Method | getRecipeBatchManager | ||
Description |
Gets the | ||
Return | osid.recipe.batch.RecipeBatchManager | a RecipeBatchManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRecipeBatch() is false | ||
Compliance | optional | This method must be implemented if supportsRecipeBatch() is
true. |