OSID Logo
OSID Specifications
recipe package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recipe.RecipeProxyManager
Implementsosid.OsidProxyManager
osid.recipe.RecipeProfile
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 cook books
  • RecipeCookbookAssignmentSession: a session to manage recipe to cook book mappings
  • RecipeCookbookAssignmentSession: a session to manage dynamic cook books 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 cook book mappings
  • DirectionCookbookAssignmentSession: a session to manage direction to cook book mappings
  • DirectionSmartCookbookSession: a session to manage dynamic cook books 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 cook book mappings
  • ProcedureCookbookAssignmentSession: a session to manage procedure cook book mappings
  • ProcedureSmartCookbookSession: a session to manage smart cook books of procedures
  • CookbookLookupSession: a session to retrieve cook books
  • CookbookQuerySession: a session to query cook books
  • CookbookSearchSession: a session to search for cook books
  • CookbookAdminSession: a session to create, update and delete cook books
  • CookbookNotificationSession: a session to receive notifications for changes in cook books
  • CookbookHierarchyTraversalSession: a session to traverse hierarchies of cook books
  • CookbookHierarchyDesignSession: a session to manage hierarchies of cook books
MethodgetRecipeLookupSession
Description

Gets the OsidSession associated with the recipe lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.recipe.RecipeLookupSessiona RecipeLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRecipeLookup() 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_ARGUMENT cookbookId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRecipeLookup() 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_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRecipeQuery() 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 cook book found by the given Id
NULL_ARGUMENT cookbookId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRecipeQuery() 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_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRecipeSearch() 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 cook book found by the given Id
NULL_ARGUMENT cookbookId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRecipeSearch() 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_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRecipeAdmin() 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 cook book found by the given Id
NULL_ARGUMENT cookbookId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRecipeAdmin() 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_ARGUMENT recipeReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRecipeNotification() 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 cook book found by the given Id
NULL_ARGUMENT recipeReceiver, cookbookId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRecipeNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRecipeNotification() and supportsVisibleFederation() are true
MethodgetRecipeCookbookSession
Description

Gets the OsidSession to lookup recipe/cook book mappings.

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

Gets the OsidSession associated with assigning recipes to cook books.

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

Gets the OsidSession to manage recipe smart cook books.

Parametersosid.id.IdcookbookIdthe Id of the Cookbook
osid.proxy.Proxyproxya proxy
Returnosid.recipe.RecipeSmartCookbookSessiona RecipeSmartCookbookSession
ErrorsNOT_FOUNDno cook book found by the given Id
NULL_ARGUMENT cookbookId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRecipeSmartCookbook() 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_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDirectionLookup() 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 cook book
osid.proxy.Proxyproxya proxy
Returnosid.recipe.DirectionLookupSessiona DirectionLookupSession
ErrorsNOT_FOUNDno Cookbook found by the given Id
NULL_ARGUMENT cookbookId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDirectionLookup() 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_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDirectionQuery() 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 cook book found by the given Id
NULL_ARGUMENT cookbookId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDirectionQuery() 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_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDirectionSearch() 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 cook book found by the given Id
NULL_ARGUMENT cookbookId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDirectionSearch() 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_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDirectionAdmin() 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 cook book found by the given Id
NULL_ARGUMENT cookbookId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDirectionAdmin() 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_ARGUMENT directionReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDirectionNotification() 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 cook book found by the given Id
NULL_ARGUMENT directionReceiver, cookbookId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDirectionNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDirectionNotification() and supportsVisibleFederation() are true
MethodgetDirectionCookbookSession
Description

Gets the OsidSession to lookup direction/cook book ingredients.

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

Gets the OsidSession associated with assigning mappings to cook books.

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

Gets the OsidSession to manage locatin smart cook books.

Parametersosid.id.IdcookbookIdthe Id of the Cookbook
osid.proxy.Proxyproxya proxy
Returnosid.recipe.DirectionSmartCookbookSessiona DirectionSmartCookbookSession
ErrorsNOT_FOUNDno cook book found by the given Id
NULL_ARGUMENT cookbookId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDirectionSmartCookbook() 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_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcedureLookup() 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_ARGUMENT cookbookId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcedureLookup() 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_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcedureQuery() 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_ARGUMENT cookbookId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcedureQuery() 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_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcedureSearch() 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_ARGUMENT cookbookId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcedureSearch() 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_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcedureAdmin() 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_ARGUMENT cookbookId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcedureAdmin() 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_ARGUMENT procedureReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcedureNotification() 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_ARGUMENT procedureReceiver, cookbookId, or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcedureNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProcedureNotification() and supportsVisibleFederation() are true
MethodgetProcedureCookbookSession
Description

Gets the session for retrieving procedure to cook book mappings.

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

Gets the session for assigning procedure to cook book mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.recipe.ProcedureCookbookAssignmentSessiona ProcedureCookbookAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcedureCookbookAssignment() is false
ComplianceoptionalThis method must be implemented if supportsProcedureCookbookAssignment() is true.
MethodgetProcedureSmartCookbookSession
Description

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

Parametersosid.id.IdcookbookIdthe Id of the procedure book
osid.proxy.Proxyproxya proxy
Returnosid.recipe.ProcedureSmartCookbookSessiona ProcedureSmartCookbookSession
ErrorsNOT_FOUND procedureBookId not found
NULL_ARGUMENT procedureBookId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProcedureSmartCookbook() is false
ComplianceoptionalThis method must be implemented if supportsProcedureSmartCookbook() is true.
MethodgetCookbookLookupSession
Description

Gets the OsidSession associated with the cook book lookup service.

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

Gets the OsidSession associated with the cook book query service.

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

Gets the OsidSession associated with the cook book search service.

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

Gets the OsidSession associated with the cook book administrative service.

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

Gets the OsidSession associated with the cook book notification service.

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

Gets the OsidSession associated with the cook book hierarchy service.

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

Gets the OsidSession associated with the cook book hierarchy design service.

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

Gets the RecipieBatchProxyManager .

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