OSID Logo
OSID Specifications
recipe package
Version 3.0.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.Proxyproxya proxy
Returnosid.recipe.RecipeLookupSessiona RecipeLookupSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsRecipeLookup() is false
ComplianceoptionalThis 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.IdcookbookIdthe Id of the Cookbook
osid.proxy.Proxyproxya proxy
Returnosid.recipe.RecipeLookupSessiona RecipeLookupSession
ErrorsNOT_FOUNDno Cookbook found by the given Id
NULL_ARGUMENTcookbookId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsRecipeLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRecipeLookup() and supportsVisibleFederation() are true
MethodgetRecipeQuerySession
Description

Gets the OsidSession associated with the recipe query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.recipe.RecipeQuerySessiona RecipeQuerySession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsRecipeQuery() is false
ComplianceoptionalThis 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.IdcookbookIdthe Id of the Cookbook
osid.proxy.Proxyproxya proxy
Returnosid.recipe.RecipeQuerySessiona RecipeQuerySession
ErrorsNOT_FOUNDno cookbook found by the given Id
NULL_ARGUMENTcookbookId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsRecipeQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRecipeQuery() and supportsVisibleFederation() are true
MethodgetRecipeSearchSession
Description

Gets the OsidSession associated with the recipe search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.recipe.RecipeSearchSessiona RecipeSearchSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsRecipeSearch() is false
ComplianceoptionalThis 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.IdcookbookIdthe Id of the Cookbook
osid.proxy.Proxyproxya proxy
Returnosid.recipe.RecipeSearchSessiona RecipeSearchSession
ErrorsNOT_FOUNDno cookbook found by the given Id
NULL_ARGUMENTcookbookId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsRecipeSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRecipeSearch() and supportsVisibleFederation() are true
MethodgetRecipeAdminSession
Description

Gets the OsidSession associated with the recipe administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.recipe.RecipeAdminSessiona RecipeAdminSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsRecipeAdmin() is false
ComplianceoptionalThis 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.IdcookbookIdthe Id of the Cookbook
osid.proxy.Proxyproxya proxy
Returnosid.recipe.RecipeAdminSessiona RecipeAdminSession
ErrorsNOT_FOUNDno cookbook found by the given Id
NULL_ARGUMENTcookbookId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsRecipeAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRecipeAdmin() and supportsVisibleFederation() are true
MethodgetRecipeNotificationSession
Description

Gets the OsidSession associated with the recipe notification service.

Parametersosid.recipe.RecipeReceiverrecipeReceiverthe notification callback
osid.proxy.Proxyproxya proxy
Returnosid.recipe.RecipeNotificationSessiona RecipeNotificationSession
ErrorsNULL_ARGUMENTrecipeReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsRecipeNotification() is false
ComplianceoptionalThis 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.RecipeReceiverrecipeReceiverthe notification callback
osid.id.IdcookbookIdthe Id of the Cookbook
osid.proxy.Proxyproxya proxy
Returnosid.recipe.RecipeNotificationSessiona RecipeNotificationSession
ErrorsNOT_FOUNDno cookbook found by the given Id
NULL_ARGUMENTrecipeReceiver, cookbookId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsRecipeNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRecipeNotification() and supportsVisibleFederation() are true
MethodgetRecipeCookbookSession
Description

Gets the OsidSession to lookup recipe/cookbook mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.recipe.RecipeCookbookSessiona RecipeCookbookSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsRecipeCookbook() is false
ComplianceoptionalThis method must be implemented if supportsRecipeCookbook() is true .
MethodgetRecipeCookbookAssignmentSession
Description

Gets the OsidSession associated with assigning recipes to cookbooks.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.recipe.RecipeCookbookAssignmentSessiona RecipeCookbookAssignmentSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsRecipeCookbookAssignment() is false
ComplianceoptionalThis method must be implemented if supportsRecipeCookbookAssignment() is true .
MethodgetRecipeSmartCookbookSession
Description

Gets the OsidSession to manage recipe smart cookbooks.

Parametersosid.id.IdcookbookIdthe Id of the Cookbook
osid.proxy.Proxyproxya proxy
Returnosid.recipe.RecipeSmartCookbookSessiona RecipeSmartCookbookSession
ErrorsNOT_FOUNDno cookbook found by the given Id
NULL_ARGUMENTcookbookId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsRecipeSmartCookbook() is false
ComplianceoptionalThis method must be implemented if supportsRecipeSmartCookbook() is true .
MethodgetDirectionLookupSession
Description

Gets the OsidSession associated with the direction lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.recipe.DirectionLookupSessiona DirectionLookupSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDirectionLookup() is false
ComplianceoptionalThis 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.IdcookbookIdthe Id of the cookbook
osid.proxy.Proxyproxya proxy
Returnosid.recipe.DirectionLookupSessiona DirectionLookupSession
ErrorsNOT_FOUNDno Cookbook found by the given Id
NULL_ARGUMENTcookbookId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDirectionLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDirectionLookup() and supportsVisibleFederation() are true
MethodgetDirectionQuerySession
Description

Gets the OsidSession associated with the direction query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.recipe.DirectionQuerySessiona DirectionQuerySession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDirectionQuery() is false
ComplianceoptionalThis 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.IdcookbookIdthe Id of the Cookbook
osid.proxy.Proxyproxya proxy
Returnosid.recipe.DirectionQuerySessiona DirectionQuerySession
ErrorsNOT_FOUNDno Cookbook found by the given Id
NULL_ARGUMENTcookbookId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDirectionQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDirectionQuery() and supportsVisibleFederation() are true
MethodgetDirectionSearchSession
Description

Gets the OsidSession associated with the direction search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.recipe.DirectionSearchSessiona DirectionSearchSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDirectionSearch() is false
ComplianceoptionalThis 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.IdcookbookIdthe Id of the Cookbook
osid.proxy.Proxyproxya proxy
Returnosid.recipe.DirectionSearchSessiona DirectionSearchSession
ErrorsNOT_FOUNDno Cookbook found by the given Id
NULL_ARGUMENTcookbookId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDirectionSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDirectionSearch() and supportsVisibleFederation() are true
MethodgetDirectionAdminSession
Description

Gets the OsidSession associated with the direction administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.recipe.DirectionAdminSessiona DirectionAdminSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDirectionAdmin() is false
ComplianceoptionalThis 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.IdcookbookIdthe Id of the Cookbook
osid.proxy.Proxyproxya proxy
Returnosid.recipe.DirectionAdminSessiona DirectionAdminSession
ErrorsNOT_FOUNDno Cookbook found by the given Id
NULL_ARGUMENTcookbookId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDirectionAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDirectionAdmin() and supportsVisibleFederation() are true
MethodgetDirectionNotificationSession
Description

Gets the OsidSession associated with the direction notification service.

Parametersosid.recipe.DirectionReceiverdirectionReceiverthe notification callback
osid.proxy.Proxyproxya proxy
Returnosid.recipe.DirectionNotificationSessiona DirectionNotificationSession
ErrorsNULL_ARGUMENTdirectionReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDirectionNotification() is false
ComplianceoptionalThis 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.DirectionReceiverdirectionReceiverthe notification callback
osid.id.IdcookbookIdthe Id of the Cookbook
osid.proxy.Proxyproxya proxy
Returnosid.recipe.DirectionNotificationSessiona DirectionNotificationSession
ErrorsNOT_FOUNDno Cookbook found by the given Id
NULL_ARGUMENTdirectionReceiver , cookbookId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDirectionNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDirectionNotification() and supportsVisibleFederation() are true
MethodgetDirectionCookbookSession
Description

Gets the OsidSession to lookup direction/cookbook ingredients.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.recipe.DirectionCookbookSessiona DirectionCookbookSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDirectionCookbook() is false
ComplianceoptionalThis method must be implemented if supportsDirectionCookbook() is true .
MethodgetDirectionCookbookAssignmentSession
Description

Gets the OsidSession associated with assigning mappings to cookbooks.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.recipe.DirectionCookbookAssignmentSessiona DirectionCookbookAssignmentSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDirectionCookbookAssignment() is false
ComplianceoptionalThis method must be implemented if supportsDirectionCookbookAssignment() is true .
MethodgetDirectionSmartCookbookSession
Description

Gets the OsidSession to manage locatin smart cookbooks.

Parametersosid.id.IdcookbookIdthe Id of the Cookbook
osid.proxy.Proxyproxya proxy
Returnosid.recipe.DirectionSmartCookbookSessiona DirectionSmartCookbookSession
ErrorsNOT_FOUNDno cookbook found by the given Id
NULL_ARGUMENTcookbookId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDirectionSmartCookbook() is false
ComplianceoptionalThis method must be implemented if supportsDirectionSmartCookbook() is true .
MethodgetProcedureLookupSession
Description

Gets the OsidSession associated with the procedure lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.recipe.ProcedureLookupSessiona ProcedureLookupSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcedureLookup() is false
ComplianceoptionalThis 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.IdcookbookIdthe Id of the Cookbook
osid.proxy.Proxyproxya proxy
Returnosid.recipe.ProcedureLookupSessiona ProcedureLookupSession
ErrorsNOT_FOUNDno Cookbook found by the given Id
NULL_ARGUMENTcookbookId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcedureLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcedureLookup() and supportsVisibleFederation() are true
MethodgetProcedureQuerySession
Description

Gets the OsidSession associated with the procedure query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.recipe.ProcedureQuerySessiona ProcedureQuerySession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcedureQuery() is false
ComplianceoptionalThis 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.IdcookbookIdthe Id of the Cookbook
osid.proxy.Proxyproxya proxy
Returnosid.recipe.ProcedureQuerySessiona ProcedureQuerySession
ErrorsNOT_FOUNDno Cookbook found by the given Id
NULL_ARGUMENTcookbookId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcedureQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcedureQuery() and supportsVisibleFederation() are true
MethodgetProcedureSearchSession
Description

Gets the OsidSession associated with the procedure search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.recipe.ProcedureSearchSessiona ProcedureSearchSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcedureSearch() is false
ComplianceoptionalThis 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.IdcookbookIdthe Id of the Cookbook
osid.proxy.Proxyproxya proxy
Returnosid.recipe.ProcedureSearchSessiona ProcedureSearchSession
ErrorsNOT_FOUNDno Cookbook found by the given Id
NULL_ARGUMENTcookbookId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcedureSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcedureSearch() and supportsVisibleFederation() are true
MethodgetProcedureAdminSession
Description

Gets the OsidSession associated with the procedure administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.recipe.ProcedureAdminSessiona ProcedureAdminSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcedureAdmin() is false
ComplianceoptionalThis 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.IdcookbookIdthe Id of the Cookbook
osid.proxy.Proxyproxya proxy
Returnosid.recipe.ProcedureAdminSessiona ProcedureAdminSession
ErrorsNOT_FOUNDno Cookbook found by the given Id
NULL_ARGUMENTcookbookId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcedureAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcedureAdmin() and supportsVisibleFederation() are true
MethodgetProcedureNotificationSession
Description

Gets the OsidSession associated with the procedure notification service.

Parametersosid.recipe.ProcedureReceiverprocedureReceiverthe receiver
osid.proxy.Proxyproxya proxy
Returnosid.recipe.ProcedureNotificationSessiona ProcedureNotificationSession
ErrorsNULL_ARGUMENTprocedureReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcedureNotification() is false
ComplianceoptionalThis 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.ProcedureReceiverprocedureReceiverthe receiver
osid.id.IdcookbookIdthe Id of the Cookbook
osid.proxy.Proxyproxya proxy
Returnosid.recipe.ProcedureNotificationSessiona ProcedureNotificationSession
ErrorsNOT_FOUNDno Cookbook found by the given Id
NULL_ARGUMENTprocedureReceiver, cookbookId , or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcedureNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcedureNotification() and supportsVisibleFederation() are true
MethodgetProcedureCookbookSession
Description

Gets the session for retrieving procedure to cookbook mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.recipe.ProcedureCookbookSessiona ProcedureCookbookSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcedureCookbook() is false
ComplianceoptionalThis method must be implemented if supportsProcedureCookbook() is true .
MethodgetProcedureCookbookAssignmentSession
Description

Gets the session for assigning procedure to cookbook mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.recipe.ProcedureCookbookAssignmentSessiona ProcedureCookbookAssignmentSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcedureCookbookAssignment() is false
ComplianceoptionalThis 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.IdcookbookIdthe Id of the procedure book
osid.proxy.Proxyproxya proxy
Returnosid.recipe.ProcedureSmartCookbookSessiona ProcedureSmartCookbookSession
ErrorsNOT_FOUNDprocedureBookId not found
NULL_ARGUMENTprocedureBookId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsProcedureSmartCookbook() is false
ComplianceoptionalThis method must be implemented if supportsProcedureSmartCookbook() is true .
MethodgetCookbookLookupSession
Description

Gets the OsidSession associated with the cookbook lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.recipe.CookbookLookupSessiona CookbookLookupSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsCookbookLookup() is false
ComplianceoptionalThis method must be implemented if supportsCookbookLookup() is true .
MethodgetCookbookQuerySession
Description

Gets the OsidSession associated with the cookbook query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.recipe.CookbookQuerySessiona CookbookQuerySession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsCookbookQuery() is false
ComplianceoptionalThis method must be implemented if supportsCookbookQuery() is true .
MethodgetCookbookSearchSession
Description

Gets the OsidSession associated with the cookbook search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.recipe.CookbookSearchSessiona CookbookSearchSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsCookbookSearch() is false
ComplianceoptionalThis method must be implemented if supportsCookbookSearch() is true .
MethodgetCookbookAdminSession
Description

Gets the OsidSession associated with the cookbook administrative service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.recipe.CookbookAdminSessiona CookbookAdminSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsCookbookAdmin() is false
ComplianceoptionalThis method must be implemented if supportsCookbookAdmin() is true .
MethodgetCookbookNotificationSession
Description

Gets the OsidSession associated with the cookbook notification service.

Parametersosid.recipe.CookbookReceivercookbookReceiverthe receiver
osid.proxy.Proxyproxya proxy
Returnosid.recipe.CookbookNotificationSessiona CookbookNotificationSession
ErrorsNULL_ARGUMENTcookbookReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsCookbookNotification() is false
ComplianceoptionalThis method must be implemented if supportsCookbookNotification() is true .
MethodgetCookbookHierarchySession
Description

Gets the OsidSession associated with the cookbook hierarchy service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.recipe.CookbookHierarchySessiona CookbookHierarchySession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsCookbookHierarchy() is false
ComplianceoptionalThis method must be implemented if supportsCookbookHierarchy() is true .
MethodgetCookbookHierarchyDesignSession
Description

Gets the OsidSession associated with the cookbook hierarchy design service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.recipe.CookbookHierarchyDesignSessiona CookbookHierarchyDesignSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsCookbookHierarchyDesign() is false
ComplianceoptionalThis method must be implemented if supportsCookbookHierarchyDesign() is true .
MethodgetRecipeBatchProxyManager
Description

Gets the RecipeBatchProxyManager .

Returnosid.recipe.batch.RecipeBatchProxyManagera RecipeBatchProxyManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsRecipeBatch() is false
ComplianceoptionalThis method must be implemented if supportsRecipeBatch() is true .