OSID Logo
OSID Specifications
recipe package
Version 3.1.0
Interfaceosid.recipe.RecipeProxyManager
Implementsosid.OsidProxyManager
osid.recipe.RecipeProfile
Used Byosid.orchestration.OrchestrationManager
Description

The recipe manager provides access to procedure sessions and provides interoperability tests for various aspects of this service. Methods in this manager accept a Proxy for passing information from a server environment. The sessions included in this manager are:

  • RecipeLookupSession: a session to retrieve recipes
  • RecipeQuerySession: a session to query for recipes
  • RecipeSearchSession: a session to search for recipes
  • RecipeAdminSession: a session to create and delete recipes
  • RecipeNotificationSession: a session to receive notifications pertaining to recipe changes
  • RecipeCookbookSession: a session to looking mappings of recipes to cookbooks
  • RecipeCookbookAssignmentSession: a session to manage recipe to cookbook mappings
  • RecipeCookbookAssignmentSession: a session to manage dynamic cookbooks of recipes
  • DirectionLookupSession: a session to retrieve directions
  • DirectionQuerySession: a session to query for directions
  • DirectionSearchSession: a session to search for directions
  • DirectionAdminSession: a session to create and delete directions
  • DirectionNotificationSession: a session to receive notifications pertaining to direction changes
  • DirectionCookbookSession: a session to look up direction cookbook mappings
  • DirectionCookbookAssignmentSession: a session to manage direction to cookbook mappings
  • DirectionSmartCookbookSession: a session to manage dynamic cookbooks of directions
  • ProcedureLookupSession: a session to lookup procedures
  • ProcedureQuerySession: a session to query procedures
  • ProcedureSearchSession: a session to search procedures
  • ProcedureAdminSession: a session to manage procedures
  • ProcedureNotificationSession: a session to subscribe to notifications of procedure changes
  • ProcedureCookbookSession: a session to lookup procedure cookbook mappings
  • ProcedureCookbookAssignmentSession: a session to manage procedure cookbook mappings
  • ProcedureSmartCookbookSession: a session to manage smart cookbooks of procedures
  • CookbookLookupSession: a session to retrieve cookbooks
  • CookbookQuerySession: a session to query cookbooks
  • CookbookSearchSession: a session to search for coo books
  • CookbookAdminSession: a session to create, update and delete cookbooks
  • CookbookNotificationSession: a session to receive notifications for changes in cookbooks
  • CookbookHierarchyTraversalSession: a session to traverse hierarchies of cookbooks
  • CookbookHierarchyDesignSession: a session to manage hierarchies of cookbooks
MethodgetRecipeLookupSession
Description

Gets the OsidSession associated with the recipe lookup service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.recipe.RecipeLookupSession a RecipeLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRecipeLookup() is false
Complianceoptional This method must be implemented if supportsRecipeLookup() is true.
MethodgetRecipeLookupSessionForCookbook
Description

Gets the OsidSession associated with the recipe lookup service for the given cookbook.

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

Gets the OsidSession associated with the recipe query service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.recipe.RecipeQuerySession a RecipeQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRecipeQuery() is false
Complianceoptional This method must be implemented if supportsRecipeQuery() is true.
MethodgetRecipeQuerySessionForCookbook
Description

Gets the OsidSession associated with the recipe query service for the given cookbook.

Parametersosid.id.IdcookbookId the Id of the Cookbook
osid.proxy.Proxyproxy a proxy
Returnosid.recipe.RecipeQuerySession a RecipeQuerySession
ErrorsNOT_FOUND no cookbook found by the given Id
NULL_ARGUMENT cookbookId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRecipeQuery() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsRecipeQuery() and supportsVisibleFederation() are true
MethodgetRecipeSearchSession
Description

Gets the OsidSession associated with the recipe search service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.recipe.RecipeSearchSession a RecipeSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRecipeSearch() is false
Complianceoptional This method must be implemented if supportsRecipeSearch() is true.
MethodgetRecipeSearchSessionForCookbook
Description

Gets the OsidSession associated with the recipe search service for the given cookbook.

Parametersosid.id.IdcookbookId the Id of the Cookbook
osid.proxy.Proxyproxy a proxy
Returnosid.recipe.RecipeSearchSession a RecipeSearchSession
ErrorsNOT_FOUND no cookbook found by the given Id
NULL_ARGUMENT cookbookId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRecipeSearch() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsRecipeSearch() and supportsVisibleFederation() are true
MethodgetRecipeAdminSession
Description

Gets the OsidSession associated with the recipe administration service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.recipe.RecipeAdminSession a RecipeAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRecipeAdmin() is false
Complianceoptional This method must be implemented if supportsRecipeAdmin() is true.
MethodgetRecipeAdminSessionForCookbook
Description

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

Parametersosid.id.IdcookbookId the Id of the Cookbook
osid.proxy.Proxyproxy a proxy
Returnosid.recipe.RecipeAdminSession a RecipeAdminSession
ErrorsNOT_FOUND no cookbook found by the given Id
NULL_ARGUMENT cookbookId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRecipeAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsRecipeAdmin() and supportsVisibleFederation() are true
MethodgetRecipeNotificationSession
Description

Gets the OsidSession associated with the recipe notification service.

Parametersosid.recipe.RecipeReceiverrecipeReceiver the notification callback
osid.proxy.Proxyproxy a proxy
Returnosid.recipe.RecipeNotificationSession a RecipeNotificationSession
ErrorsNULL_ARGUMENT recipeReceiver or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRecipeNotification() is false
Complianceoptional This method must be implemented if supportsRecipeNotification() is true.
MethodgetRecipeNotificationSessionForCookbook
Description

Gets the OsidSession associated with the recipe notification service for the given cookbook.

Parametersosid.recipe.RecipeReceiverrecipeReceiver the notification callback
osid.id.IdcookbookId the Id of the Cookbook
osid.proxy.Proxyproxy a proxy
Returnosid.recipe.RecipeNotificationSession a RecipeNotificationSession
ErrorsNOT_FOUND no cookbook found by the given Id
NULL_ARGUMENT recipeReceiver, cookbookId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRecipeNotification() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsRecipeNotification() and supportsVisibleFederation() are true
MethodgetRecipeCookbookSession
Description

Gets the OsidSession to lookup recipe/cookbook mappings.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.recipe.RecipeCookbookSession a RecipeCookbookSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRecipeCookbook() is false
Complianceoptional This method must be implemented if supportsRecipeCookbook() is true.
MethodgetRecipeCookbookAssignmentSession
Description

Gets the OsidSession associated with assigning recipes to cookbooks.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.recipe.RecipeCookbookAssignmentSession a RecipeCookbookAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRecipeCookbookAssignment() is false
Complianceoptional This method must be implemented if supportsRecipeCookbookAssignment() is true.
MethodgetRecipeSmartCookbookSession
Description

Gets the OsidSession to manage recipe smart cookbooks.

Parametersosid.id.IdcookbookId the Id of the Cookbook
osid.proxy.Proxyproxy a proxy
Returnosid.recipe.RecipeSmartCookbookSession a RecipeSmartCookbookSession
ErrorsNOT_FOUND no cookbook found by the given Id
NULL_ARGUMENT cookbookId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRecipeSmartCookbook() is false
Complianceoptional This method must be implemented if supportsRecipeSmartCookbook() is true.
MethodgetDirectionLookupSession
Description

Gets the OsidSession associated with the direction lookup service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.recipe.DirectionLookupSession a DirectionLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsDirectionLookup() is false
Complianceoptional This method must be implemented if supportsDirectionLookup() is true.
MethodgetDirectionLookupSessionForCookbook
Description

Gets the OsidSession associated with the direction lookup service for the given cookbook.

Parametersosid.id.IdcookbookId the Id of the cookbook
osid.proxy.Proxyproxy a proxy
Returnosid.recipe.DirectionLookupSession a DirectionLookupSession
ErrorsNOT_FOUND no Cookbook found by the given Id
NULL_ARGUMENT cookbookId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsDirectionLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsDirectionLookup() and supportsVisibleFederation() are true
MethodgetDirectionQuerySession
Description

Gets the OsidSession associated with the direction query service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.recipe.DirectionQuerySession a DirectionQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsDirectionQuery() is false
Complianceoptional This method must be implemented if supportsDirectionQuery() is true.
MethodgetDirectionQuerySessionForCookbook
Description

Gets the OsidSession associated with the direction query service for the given cookbook.

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

Gets the OsidSession associated with the direction search service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.recipe.DirectionSearchSession a DirectionSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsDirectionSearch() is false
Complianceoptional This method must be implemented if supportsDirectionSearch() is true.
MethodgetDirectionSearchSessionForCookbook
Description

Gets the OsidSession associated with the direction search service for the given cookbook.

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

Gets the OsidSession associated with the direction administration service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.recipe.DirectionAdminSession a DirectionAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsDirectionAdmin() is false
Complianceoptional This method must be implemented if supportsDirectionAdmin() is true.
MethodgetDirectionAdminSessionForCookbook
Description

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

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

Gets the OsidSession associated with the direction notification service.

Parametersosid.recipe.DirectionReceiverdirectionReceiver the notification callback
osid.proxy.Proxyproxy a proxy
Returnosid.recipe.DirectionNotificationSession a DirectionNotificationSession
ErrorsNULL_ARGUMENT directionReceiver or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsDirectionNotification() is false
Complianceoptional This method must be implemented if supportsDirectionNotification() is true.
MethodgetDirectionNotificationSessionForCookbook
Description

Gets the OsidSession associated with the direction notification service for the given cookbook.

Parametersosid.recipe.DirectionReceiverdirectionReceiver the notification callback
osid.id.IdcookbookId the Id of the Cookbook
osid.proxy.Proxyproxy a proxy
Returnosid.recipe.DirectionNotificationSession a DirectionNotificationSession
ErrorsNOT_FOUND no Cookbook found by the given Id
NULL_ARGUMENT directionReceiver, cookbookId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsDirectionNotification() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsDirectionNotification() and supportsVisibleFederation() are true
MethodgetDirectionCookbookSession
Description

Gets the OsidSession to lookup direction/cookbook ingredients.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.recipe.DirectionCookbookSession a DirectionCookbookSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsDirectionCookbook() is false
Complianceoptional This method must be implemented if supportsDirectionCookbook() is true.
MethodgetDirectionCookbookAssignmentSession
Description

Gets the OsidSession associated with assigning mappings to cookbooks.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.recipe.DirectionCookbookAssignmentSession a DirectionCookbookAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsDirectionCookbookAssignment() is false
Complianceoptional This method must be implemented if supportsDirectionCookbookAssignment() is true.
MethodgetDirectionSmartCookbookSession
Description

Gets the OsidSession to manage locatin smart cookbooks.

Parametersosid.id.IdcookbookId the Id of the Cookbook
osid.proxy.Proxyproxy a proxy
Returnosid.recipe.DirectionSmartCookbookSession a DirectionSmartCookbookSession
ErrorsNOT_FOUND no cookbook found by the given Id
NULL_ARGUMENT cookbookId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsDirectionSmartCookbook() is false
Complianceoptional This method must be implemented if supportsDirectionSmartCookbook() is true.
MethodgetProcedureLookupSession
Description

Gets the OsidSession associated with the procedure lookup service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.recipe.ProcedureLookupSession a ProcedureLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProcedureLookup() is false
Complianceoptional This method must be implemented if supportsProcedureLookup() is true.
MethodgetProcedureLookupSessionForCookbook
Description

Gets the OsidSession associated with the procedure lookup service for the given cookbook.

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

Gets the OsidSession associated with the procedure query service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.recipe.ProcedureQuerySession a ProcedureQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProcedureQuery() is false
Complianceoptional This method must be implemented if supportsProcedureQuery() is true.
MethodgetProcedureQuerySessionForCookbook
Description

Gets the OsidSession associated with the procedure query service for the given cookbook.

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

Gets the OsidSession associated with the procedure search service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.recipe.ProcedureSearchSession a ProcedureSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProcedureSearch() is false
Complianceoptional This method must be implemented if supportsProcedureSearch() is true.
MethodgetProcedureSearchSessionForCookbook
Description

Gets the OsidSession associated with the procedure search service for the given cookbook.

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

Gets the OsidSession associated with the procedure administration service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.recipe.ProcedureAdminSession a ProcedureAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProcedureAdmin() is false
Complianceoptional This method must be implemented if supportsProcedureAdmin() is true.
MethodgetProcedureAdminSessionForCookbook
Description

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

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

Gets the OsidSession associated with the procedure notification service.

Parametersosid.recipe.ProcedureReceiverprocedureReceiver the receiver
osid.proxy.Proxyproxy a proxy
Returnosid.recipe.ProcedureNotificationSession a ProcedureNotificationSession
ErrorsNULL_ARGUMENT procedureReceiver or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProcedureNotification() is false
Complianceoptional This method must be implemented if supportsProcedureNotification() is true.
MethodgetProcedureNotificationSessionForCookbook
Description

Gets the OsidSession associated with the procedure notification service for the given cookbook.

Parametersosid.recipe.ProcedureReceiverprocedureReceiver the receiver
osid.id.IdcookbookId the Id of the Cookbook
osid.proxy.Proxyproxy a proxy
Returnosid.recipe.ProcedureNotificationSession a ProcedureNotificationSession
ErrorsNOT_FOUND no Cookbook found by the given Id
NULL_ARGUMENT procedureReceiver, cookbookId, or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProcedureNotification() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsProcedureNotification() and supportsVisibleFederation() are true
MethodgetProcedureCookbookSession
Description

Gets the session for retrieving procedure to cookbook mappings.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.recipe.ProcedureCookbookSession a ProcedureCookbookSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProcedureCookbook() is false
Complianceoptional This method must be implemented if supportsProcedureCookbook() is true.
MethodgetProcedureCookbookAssignmentSession
Description

Gets the session for assigning procedure to cookbook mappings.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.recipe.ProcedureCookbookAssignmentSession a ProcedureCookbookAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProcedureCookbookAssignment() is false
Complianceoptional This method must be implemented if supportsProcedureCookbookAssignment() is true.
MethodgetProcedureSmartCookbookSession
Description

Gets the session associated with the procedure smart cookbook for the given cookbook.

Parametersosid.id.IdcookbookId the Id of the procedure book
osid.proxy.Proxyproxy a proxy
Returnosid.recipe.ProcedureSmartCookbookSession a ProcedureSmartCookbookSession
ErrorsNOT_FOUND procedureBookId not found
NULL_ARGUMENT procedureBookId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProcedureSmartCookbook() is false
Complianceoptional This method must be implemented if supportsProcedureSmartCookbook() is true.
MethodgetCookbookLookupSession
Description

Gets the OsidSession associated with the cookbook lookup service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.recipe.CookbookLookupSession a CookbookLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCookbookLookup() is false
Complianceoptional This method must be implemented if supportsCookbookLookup() is true.
MethodgetCookbookQuerySession
Description

Gets the OsidSession associated with the cookbook query service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.recipe.CookbookQuerySession a CookbookQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCookbookQuery() is false
Complianceoptional This method must be implemented if supportsCookbookQuery() is true.
MethodgetCookbookSearchSession
Description

Gets the OsidSession associated with the cookbook search service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.recipe.CookbookSearchSession a CookbookSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCookbookSearch() is false
Complianceoptional This method must be implemented if supportsCookbookSearch() is true.
MethodgetCookbookAdminSession
Description

Gets the OsidSession associated with the cookbook administrative service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.recipe.CookbookAdminSession a CookbookAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCookbookAdmin() is false
Complianceoptional This method must be implemented if supportsCookbookAdmin() is true.
MethodgetCookbookNotificationSession
Description

Gets the OsidSession associated with the cookbook notification service.

Parametersosid.recipe.CookbookReceivercookbookReceiver the receiver
osid.proxy.Proxyproxy a proxy
Returnosid.recipe.CookbookNotificationSession a CookbookNotificationSession
ErrorsNULL_ARGUMENT cookbookReceiver or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCookbookNotification() is false
Complianceoptional This method must be implemented if supportsCookbookNotification() is true.
MethodgetCookbookHierarchySession
Description

Gets the OsidSession associated with the cookbook hierarchy service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.recipe.CookbookHierarchySession a CookbookHierarchySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCookbookHierarchy() is false
Complianceoptional This method must be implemented if supportsCookbookHierarchy() is true.
MethodgetCookbookHierarchyDesignSession
Description

Gets the OsidSession associated with the cookbook hierarchy design service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.recipe.CookbookHierarchyDesignSession a CookbookHierarchyDesignSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCookbookHierarchyDesign() is false
Complianceoptional This method must be implemented if supportsCookbookHierarchyDesign() is true.
MethodgetRecipeBatchProxyManager
Description

Gets the RecipeBatchProxyManager.

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