org.osid.recipe

Interface RecipeProxyManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidProfile, OsidProxyManager, RecipeProfile, Sourceable

public interface RecipeProxyManager
extends OsidProxyManager, RecipeProfile

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

Method Summary

Methods

Modifier and Type	Method and Description
CookbookAdminSession	getCookbookAdminSession(Proxy proxy) Gets the OsidSession associated with the cook book administrative service.
CookbookHierarchyDesignSession	getCookbookHierarchyDesignSession(Proxy proxy) Gets the OsidSession associated with the cook book hierarchy design service.
CookbookHierarchySession	getCookbookHierarchySession(Proxy proxy) Gets the OsidSession associated with the cook book hierarchy service.
CookbookLookupSession	getCookbookLookupSession(Proxy proxy) Gets the OsidSession associated with the cook book lookup service.
CookbookNotificationSession	getCookbookNotificationSession(CookbookReceiver cookbookReceiver, Proxy proxy) Gets the OsidSession associated with the cook book notification service.
CookbookQuerySession	getCookbookQuerySession(Proxy proxy) Gets the OsidSession associated with the cook book query service.
CookbookSearchSession	getCookbookSearchSession(Proxy proxy) Gets the OsidSession associated with the cook book search service.
DirectionAdminSession	getDirectionAdminSession(Proxy proxy) Gets the OsidSession associated with the direction administration service.
DirectionAdminSession	getDirectionAdminSessionForCookbook(Id cookbookId, Proxy proxy) Gets the OsidSession associated with the direction administration service for the given cookbook.
DirectionCookbookAssignmentSession	getDirectionCookbookAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning mappings to cook books.
DirectionCookbookSession	getDirectionCookbookSession(Proxy proxy) Gets the OsidSession to lookup direction/cook book ingredients.
DirectionLookupSession	getDirectionLookupSession(Proxy proxy) Gets the OsidSession associated with the direction lookup service.
DirectionLookupSession	getDirectionLookupSessionForCookbook(Id cookbookId, Proxy proxy) Gets the OsidSession associated with the direction lookup service for the given cookbook.
DirectionNotificationSession	getDirectionNotificationSession(DirectionReceiver directionReceiver, Proxy proxy) Gets the OsidSession associated with the direction notification service.
DirectionNotificationSession	getDirectionNotificationSessionForCookbook(DirectionReceiver directionReceiver, Id cookbookId, Proxy proxy) Gets the OsidSession associated with the direction notification service for the given cookbook.
DirectionQuerySession	getDirectionQuerySession(Proxy proxy) Gets the OsidSession associated with the direction query service.
DirectionQuerySession	getDirectionQuerySessionForCookbook(Id cookbookId, Proxy proxy) Gets the OsidSession associated with the direction query service for the given cookbook.
DirectionSearchSession	getDirectionSearchSession(Proxy proxy) Gets the OsidSession associated with the direction search service.
DirectionSearchSession	getDirectionSearchSessionForCookbook(Id cookbookId, Proxy proxy) Gets the OsidSession associated with the direction search service for the given cookbook.
DirectionSmartCookbookSession	getDirectionSmartCookbookSession(Id cookbookId, Proxy proxy) Gets the OsidSession to manage locatin smart cook books.
ProcedureAdminSession	getProcedureAdminSession(Proxy proxy) Gets the OsidSession associated with the procedure administration service.
ProcedureAdminSession	getProcedureAdminSessionForCookbook(Id cookbookId, Proxy proxy) Gets the OsidSession associated with the procedure administration service for the given cookbook.
ProcedureCookbookAssignmentSession	getProcedureCookbookAssignmentSession(Proxy proxy) Gets the session for assigning procedure to cook book mappings.
ProcedureCookbookSession	getProcedureCookbookSession(Proxy proxy) Gets the session for retrieving procedure to cook book mappings.
ProcedureLookupSession	getProcedureLookupSession(Proxy proxy) Gets the OsidSession associated with the procedure lookup service.
ProcedureLookupSession	getProcedureLookupSessionForCookbook(Id cookbookId, Proxy proxy) Gets the OsidSession associated with the procedure lookup service for the given cookbook.
ProcedureNotificationSession	getProcedureNotificationSession(ProcedureReceiver procedureReceiver, Proxy proxy) Gets the OsidSession associated with the procedure notification service.
ProcedureNotificationSession	getProcedureNotificationSessionForCookbook(ProcedureReceiver procedureReceiver, Id cookbookId, Proxy proxy) Gets the OsidSession associated with the procedure notification service for the given cookbook.
ProcedureQuerySession	getProcedureQuerySession(Proxy proxy) Gets the OsidSession associated with the procedure query service.
ProcedureQuerySession	getProcedureQuerySessionForCookbook(Id cookbookId, Proxy proxy) Gets the OsidSession associated with the procedure query service for the given cookbook.
ProcedureSearchSession	getProcedureSearchSession(Proxy proxy) Gets the OsidSession associated with the procedure search service.
ProcedureSearchSession	getProcedureSearchSessionForCookbook(Id cookbookId, Proxy proxy) Gets the OsidSession associated with the procedure search service for the given cookbook.
ProcedureSmartCookbookSession	getProcedureSmartCookbookSession(Id cookbookId, Proxy proxy) Gets the session associated with the procedure smart cook book for the given cookbook.
RecipeAdminSession	getRecipeAdminSession(Proxy proxy) Gets the OsidSession associated with the recipe administration service.
RecipeAdminSession	getRecipeAdminSessionForCookbook(Id cookbookId, Proxy proxy) Gets the OsidSession associated with the recipe administration service for the given cookbook.
RecipeBatchProxyManager	getRecipeBatchProxyManager() Gets the RecipieBatchProxyManager .
RecipeCookbookAssignmentSession	getRecipeCookbookAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning recipes to cook books.
RecipeCookbookSession	getRecipeCookbookSession(Proxy proxy) Gets the OsidSession to lookup recipe/cook book mappings.
RecipeLookupSession	getRecipeLookupSession(Proxy proxy) Gets the OsidSession associated with the recipe lookup service.
RecipeLookupSession	getRecipeLookupSessionForCookbook(Id cookbookId, Proxy proxy) Gets the OsidSession associated with the recipe lookup service for the given cookbook.
RecipeNotificationSession	getRecipeNotificationSession(RecipeReceiver recipeReceiver, Proxy proxy) Gets the OsidSession associated with the recipe notification service.
RecipeNotificationSession	getRecipeNotificationSessionForCookbook(RecipeReceiver recipeReceiver, Id cookbookId, Proxy proxy) Gets the OsidSession associated with the recipe notification service for the given cookbook.
RecipeQuerySession	getRecipeQuerySession(Proxy proxy) Gets the OsidSession associated with the recipe query service.
RecipeQuerySession	getRecipeQuerySessionForCookbook(Id cookbookId, Proxy proxy) Gets the OsidSession associated with the recipe query service for the given cookbook.
RecipeSearchSession	getRecipeSearchSession(Proxy proxy) Gets the OsidSession associated with the recipe search service.
RecipeSearchSession	getRecipeSearchSessionForCookbook(Id cookbookId, Proxy proxy) Gets the OsidSession associated with the recipe search service for the given cookbook.
RecipeSmartCookbookSession	getRecipeSmartCookbookSession(Id cookbookId, Proxy proxy) Gets the OsidSession to manage recipe smart cook books.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidProxyManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.recipe.RecipeProfile

getCookbookRecordTypes, getCookbookSearchRecordTypes, getDirectionRecordTypes, getDirectionSearchRecordTypes, getIngredientRecordTypes, getProcedureRecordTypes, getProcedureSearchRecordTypes, getRecipeRecordTypes, getRecipeSearchRecordTypes, supportsCookbookAdmin, supportsCookbookHierarchy, supportsCookbookHierarchyDesign, supportsCookbookLookup, supportsCookbookNotification, supportsCookbookQuery, supportsCookbookRecordType, supportsCookbookSearch, supportsCookbookSearchRecordType, supportsDirectionAdmin, supportsDirectionCookbook, supportsDirectionCookbookAssignment, supportsDirectionLookup, supportsDirectionNotification, supportsDirectionQuery, supportsDirectionRecordType, supportsDirectionSearch, supportsDirectionSearchRecordType, supportsDirectionSmartCookbook, supportsIngredientRecordType, supportsProcedureAdmin, supportsProcedureCookbook, supportsProcedureCookbookAssignment, supportsProcedureLookup, supportsProcedureNotification, supportsProcedureQuery, supportsProcedureRecordType, supportsProcedureSearch, supportsProcedureSearchRecordType, supportsProcedureSmartCookbook, supportsRecipeAdmin, supportsRecipeCookbook, supportsRecipeCookbookAssignment, supportsRecipeLookup, supportsRecipeNotification, supportsRecipeQuery, supportsRecipeRecordType, supportsRecipeSearch, supportsRecipeSearchRecordType, supportsRecipeSmartCookbook, supportsRecipieBatch, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getRecipeLookupSession

RecipeLookupSession getRecipeLookupSession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the recipe lookup service.

Parameters:

proxy - a proxy

Returns:

a RecipeLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRecipeLookup() is false

Compliance:

optional - This method must be implemented if supportsRecipeLookup() is true.

getRecipeLookupSessionForCookbook

RecipeLookupSession getRecipeLookupSessionForCookbook(Id cookbookId,
                                                    Proxy proxy)
                                                      throws NotFoundException,
                                                             OperationFailedException

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

Parameters:

cookbookId - the Id of the Cookbook

proxy - a proxy

Returns:

a RecipeLookupSession

Throws:

NotFoundException - no Cookbook found by the given Id

NullArgumentException - cookbookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRecipeLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRecipeLookup() and supportsVisibleFederation() are true

getRecipeQuerySession

RecipeQuerySession getRecipeQuerySession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the recipe query service.

Parameters:

proxy - a proxy

Returns:

a RecipeQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRecipeQuery() is false

Compliance:

optional - This method must be implemented if supportsRecipeQuery() is true.

getRecipeQuerySessionForCookbook

RecipeQuerySession getRecipeQuerySessionForCookbook(Id cookbookId,
                                                  Proxy proxy)
                                                    throws NotFoundException,
                                                           OperationFailedException

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

Parameters:

cookbookId - the Id of the Cookbook

proxy - a proxy

Returns:

a RecipeQuerySession

Throws:

NotFoundException - no cook book found by the given Id

NullArgumentException - cookbookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRecipeQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRecipeQuery() and supportsVisibleFederation() are true

getRecipeSearchSession

RecipeSearchSession getRecipeSearchSession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the recipe search service.

Parameters:

proxy - a proxy

Returns:

a RecipeSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRecipeSearch() is false

Compliance:

optional - This method must be implemented if supportsRecipeSearch() is true.

getRecipeSearchSessionForCookbook

RecipeSearchSession getRecipeSearchSessionForCookbook(Id cookbookId,
                                                    Proxy proxy)
                                                      throws NotFoundException,
                                                             OperationFailedException

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

Parameters:

cookbookId - the Id of the Cookbook

proxy - a proxy

Returns:

a RecipeSearchSession

Throws:

NotFoundException - no cook book found by the given Id

NullArgumentException - cookbookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRecipeSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRecipeSearch() and supportsVisibleFederation() are true

getRecipeAdminSession

RecipeAdminSession getRecipeAdminSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the recipe administration service.

Parameters:

proxy - a proxy

Returns:

a RecipeAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRecipeAdmin() is false

Compliance:

optional - This method must be implemented if supportsRecipeAdmin() is true.

getRecipeAdminSessionForCookbook

RecipeAdminSession getRecipeAdminSessionForCookbook(Id cookbookId,
                                                  Proxy proxy)
                                                    throws NotFoundException,
                                                           OperationFailedException

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

Parameters:

cookbookId - the Id of the Cookbook

proxy - a proxy

Returns:

a RecipeAdminSession

Throws:

NotFoundException - no cook book found by the given Id

NullArgumentException - cookbookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRecipeAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRecipeAdmin() and supportsVisibleFederation() are true

getRecipeNotificationSession

RecipeNotificationSession getRecipeNotificationSession(RecipeReceiver recipeReceiver,
                                                     Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the recipe notification service.

Parameters:

recipeReceiver - the notification callback

proxy - a proxy

Returns:

a RecipeNotificationSession

Throws:

NullArgumentException - recipeReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRecipeNotification() is false

Compliance:

optional - This method must be implemented if supportsRecipeNotification() is true.

getRecipeNotificationSessionForCookbook

RecipeNotificationSession getRecipeNotificationSessionForCookbook(RecipeReceiver recipeReceiver,
                                                                Id cookbookId,
                                                                Proxy proxy)
                                                                  throws NotFoundException,
                                                                         OperationFailedException

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

Parameters:

recipeReceiver - the notification callback

cookbookId - the Id of the Cookbook

proxy - a proxy

Returns:

a RecipeNotificationSession

Throws:

NotFoundException - no cook book found by the given Id

NullArgumentException - recipeReceiver, cookbookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRecipeNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRecipeNotification() and supportsVisibleFederation() are true

getRecipeCookbookSession

RecipeCookbookSession getRecipeCookbookSession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession to lookup recipe/cook book mappings.

Parameters:

proxy - a proxy

Returns:

a RecipeCookbookSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRecipeCookbook() is false

Compliance:

optional - This method must be implemented if supportsRecipeCookbook() is true.

getRecipeCookbookAssignmentSession

RecipeCookbookAssignmentSession getRecipeCookbookAssignmentSession(Proxy proxy)
                                                                   throws OperationFailedException

Gets the OsidSession associated with assigning recipes to cook books.

Parameters:

proxy - a proxy

Returns:

a RecipeCookbookAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRecipeCookbookAssignment() is false

Compliance:

optional - This method must be implemented if supportsRecipeCookbookAssignment() is true.

getRecipeSmartCookbookSession

RecipeSmartCookbookSession getRecipeSmartCookbookSession(Id cookbookId,
                                                       Proxy proxy)
                                                         throws NotFoundException,
                                                                OperationFailedException

Gets the OsidSession to manage recipe smart cook books.

Parameters:

cookbookId - the Id of the Cookbook

proxy - a proxy

Returns:

a RecipeSmartCookbookSession

Throws:

NotFoundException - no cook book found by the given Id

NullArgumentException - cookbookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRecipeSmartCookbook() is false

Compliance:

optional - This method must be implemented if supportsRecipeSmartCookbook() is true.

getDirectionLookupSession

DirectionLookupSession getDirectionLookupSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the direction lookup service.

Parameters:

proxy - a proxy

Returns:

a DirectionLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDirectionLookup() is false

Compliance:

optional - This method must be implemented if supportsDirectionLookup() is true.

getDirectionLookupSessionForCookbook

DirectionLookupSession getDirectionLookupSessionForCookbook(Id cookbookId,
                                                          Proxy proxy)
                                                            throws NotFoundException,
                                                                   OperationFailedException

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

Parameters:

cookbookId - the Id of the cook book

proxy - a proxy

Returns:

a DirectionLookupSession

Throws:

NotFoundException - no Cookbook found by the given Id

NullArgumentException - cookbookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDirectionLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsDirectionLookup() and supportsVisibleFederation() are true

getDirectionQuerySession

DirectionQuerySession getDirectionQuerySession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the direction query service.

Parameters:

proxy - a proxy

Returns:

a DirectionQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDirectionQuery() is false

Compliance:

optional - This method must be implemented if supportsDirectionQuery() is true.

getDirectionQuerySessionForCookbook

DirectionQuerySession getDirectionQuerySessionForCookbook(Id cookbookId,
                                                        Proxy proxy)
                                                          throws NotFoundException,
                                                                 OperationFailedException

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

Parameters:

cookbookId - the Id of the Cookbook

proxy - a proxy

Returns:

a DirectionQuerySession

Throws:

NotFoundException - no cook book found by the given Id

NullArgumentException - cookbookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDirectionQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsDirectionQuery() and supportsVisibleFederation() are true

getDirectionSearchSession

DirectionSearchSession getDirectionSearchSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the direction search service.

Parameters:

proxy - a proxy

Returns:

a DirectionSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDirectionSearch() is false

Compliance:

optional - This method must be implemented if supportsDirectionSearch() is true.

getDirectionSearchSessionForCookbook

DirectionSearchSession getDirectionSearchSessionForCookbook(Id cookbookId,
                                                          Proxy proxy)
                                                            throws NotFoundException,
                                                                   OperationFailedException

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

Parameters:

cookbookId - the Id of the Cookbook

proxy - a proxy

Returns:

a DirectionSearchSession

Throws:

NotFoundException - no cook book found by the given Id

NullArgumentException - cookbookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDirectionSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsDirectionSearch() and supportsVisibleFederation() are true

getDirectionAdminSession

DirectionAdminSession getDirectionAdminSession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the direction administration service.

Parameters:

proxy - a proxy

Returns:

a DirectionAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDirectionAdmin() is false

Compliance:

optional - This method must be implemented if supportsDirectionAdmin() is true.

getDirectionAdminSessionForCookbook

DirectionAdminSession getDirectionAdminSessionForCookbook(Id cookbookId,
                                                        Proxy proxy)
                                                          throws NotFoundException,
                                                                 OperationFailedException

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

Parameters:

cookbookId - the Id of the Cookbook

proxy - a proxy

Returns:

a DirectionAdminSession

Throws:

NotFoundException - no cook book found by the given Id

NullArgumentException - cookbookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDirectionAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsDirectionAdmin() and supportsVisibleFederation() are true

getDirectionNotificationSession

DirectionNotificationSession getDirectionNotificationSession(DirectionReceiver directionReceiver,
                                                           Proxy proxy)
                                                             throws OperationFailedException

Gets the OsidSession associated with the direction notification service.

Parameters:

directionReceiver - the notification callback

proxy - a proxy

Returns:

a DirectionNotificationSession

Throws:

NullArgumentException - directionReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDirectionNotification() is false

Compliance:

optional - This method must be implemented if supportsDirectionNotification() is true.

getDirectionNotificationSessionForCookbook

DirectionNotificationSession getDirectionNotificationSessionForCookbook(DirectionReceiver directionReceiver,
                                                                      Id cookbookId,
                                                                      Proxy proxy)
                                                                        throws NotFoundException,
                                                                               OperationFailedException

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

Parameters:

directionReceiver - the notification callback

cookbookId - the Id of the Cookbook

proxy - a proxy

Returns:

a DirectionNotificationSession

Throws:

NotFoundException - no cook book found by the given Id

NullArgumentException - directionReceiver, cookbookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDirectionNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsDirectionNotification() and supportsVisibleFederation() are true

getDirectionCookbookSession

DirectionCookbookSession getDirectionCookbookSession(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession to lookup direction/cook book ingredients.

Parameters:

proxy - a proxy

Returns:

a DirectionCookbookSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDirectionCookbook() is false

Compliance:

optional - This method must be implemented if supportsDirectionCookbook() is true.

getDirectionCookbookAssignmentSession

DirectionCookbookAssignmentSession getDirectionCookbookAssignmentSession(Proxy proxy)
                                                                         throws OperationFailedException

Gets the OsidSession associated with assigning mappings to cook books.

Parameters:

proxy - a proxy

Returns:

a DirectionCookbookAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDirectionCookbookAssignment() is false

Compliance:

optional - This method must be implemented if supportsDirectionCookbookAssignment() is true.

getDirectionSmartCookbookSession

DirectionSmartCookbookSession getDirectionSmartCookbookSession(Id cookbookId,
                                                             Proxy proxy)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the OsidSession to manage locatin smart cook books.

Parameters:

cookbookId - the Id of the Cookbook

proxy - a proxy

Returns:

a DirectionSmartCookbookSession

Throws:

NotFoundException - no cook book found by the given Id

NullArgumentException - cookbookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDirectionSmartCookbook() is false

Compliance:

optional - This method must be implemented if supportsDirectionSmartCookbook() is true.

getProcedureLookupSession

ProcedureLookupSession getProcedureLookupSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the procedure lookup service.

Parameters:

proxy - a proxy

Returns:

a ProcedureLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcedureLookup() is false

Compliance:

optional - This method must be implemented if supportsProcedureLookup() is true.

getProcedureLookupSessionForCookbook

ProcedureLookupSession getProcedureLookupSessionForCookbook(Id cookbookId,
                                                          Proxy proxy)
                                                            throws NotFoundException,
                                                                   OperationFailedException

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

Parameters:

cookbookId - the Id of the Cookbook

proxy - a proxy

Returns:

a ProcedureLookupSession

Throws:

NotFoundException - no Cookbook found by the given Id

NullArgumentException - cookbookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcedureLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsProcedureLookup() and supportsVisibleFederation() are true

getProcedureQuerySession

ProcedureQuerySession getProcedureQuerySession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the procedure query service.

Parameters:

proxy - a proxy

Returns:

a ProcedureQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcedureQuery() is false

Compliance:

optional - This method must be implemented if supportsProcedureQuery() is true.

getProcedureQuerySessionForCookbook

ProcedureQuerySession getProcedureQuerySessionForCookbook(Id cookbookId,
                                                        Proxy proxy)
                                                          throws NotFoundException,
                                                                 OperationFailedException

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

Parameters:

cookbookId - the Id of the Cookbook

proxy - a proxy

Returns:

a ProcedureQuerySession

Throws:

NotFoundException - no Cookbook found by the given Id

NullArgumentException - cookbookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcedureQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsProcedureQuery() and supportsVisibleFederation() are true

getProcedureSearchSession

ProcedureSearchSession getProcedureSearchSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the procedure search service.

Parameters:

proxy - a proxy

Returns:

a ProcedureSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcedureSearch() is false

Compliance:

optional - This method must be implemented if supportsProcedureSearch() is true.

getProcedureSearchSessionForCookbook

ProcedureSearchSession getProcedureSearchSessionForCookbook(Id cookbookId,
                                                          Proxy proxy)
                                                            throws NotFoundException,
                                                                   OperationFailedException

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

Parameters:

cookbookId - the Id of the Cookbook

proxy - a proxy

Returns:

a ProcedureSearchSession

Throws:

NotFoundException - no Cookbook found by the given Id

NullArgumentException - cookbookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcedureSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsProcedureSearch() and supportsVisibleFederation() are true

getProcedureAdminSession

ProcedureAdminSession getProcedureAdminSession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the procedure administration service.

Parameters:

proxy - a proxy

Returns:

a ProcedureAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcedureAdmin() is false

Compliance:

optional - This method must be implemented if supportsProcedureAdmin() is true.

getProcedureAdminSessionForCookbook

ProcedureAdminSession getProcedureAdminSessionForCookbook(Id cookbookId,
                                                        Proxy proxy)
                                                          throws NotFoundException,
                                                                 OperationFailedException

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

Parameters:

cookbookId - the Id of the Cookbook

proxy - a proxy

Returns:

a ProcedureAdminSession

Throws:

NotFoundException - no Cookbook found by the given Id

NullArgumentException - cookbookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcedureAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsProcedureAdmin() and supportsVisibleFederation() are true

getProcedureNotificationSession

ProcedureNotificationSession getProcedureNotificationSession(ProcedureReceiver procedureReceiver,
                                                           Proxy proxy)
                                                             throws OperationFailedException

Gets the OsidSession associated with the procedure notification service.

Parameters:

procedureReceiver - the receiver

proxy - a proxy

Returns:

a ProcedureNotificationSession

Throws:

NullArgumentException - procedureReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcedureNotification() is false

Compliance:

optional - This method must be implemented if supportsProcedureNotification() is true.

getProcedureNotificationSessionForCookbook

ProcedureNotificationSession getProcedureNotificationSessionForCookbook(ProcedureReceiver procedureReceiver,
                                                                      Id cookbookId,
                                                                      Proxy proxy)
                                                                        throws NotFoundException,
                                                                               OperationFailedException

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

Parameters:

procedureReceiver - the receiver

cookbookId - the Id of the Cookbook

proxy - a proxy

Returns:

a ProcedureNotificationSession

Throws:

NotFoundException - no Cookbook found by the given Id

NullArgumentException - procedureReceiver, cookbookId, or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcedureNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsProcedureNotification() and supportsVisibleFederation() are true

getProcedureCookbookSession

ProcedureCookbookSession getProcedureCookbookSession(Proxy proxy)
                                                     throws OperationFailedException

Gets the session for retrieving procedure to cook book mappings.

Parameters:

proxy - a proxy

Returns:

a ProcedureCookbookSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcedureCookbook() is false

Compliance:

optional - This method must be implemented if supportsProcedureCookbook() is true.

getProcedureCookbookAssignmentSession

ProcedureCookbookAssignmentSession getProcedureCookbookAssignmentSession(Proxy proxy)
                                                                         throws OperationFailedException

Gets the session for assigning procedure to cook book mappings.

Parameters:

proxy - a proxy

Returns:

a ProcedureCookbookAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcedureCookbookAssignment() is false

Compliance:

optional - This method must be implemented if supportsProcedureCookbookAssignment() is true.

getProcedureSmartCookbookSession

ProcedureSmartCookbookSession getProcedureSmartCookbookSession(Id cookbookId,
                                                             Proxy proxy)
                                                               throws NotFoundException,
                                                                      OperationFailedException

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

Parameters:

cookbookId - the Id of the procedure book

proxy - a proxy

Returns:

a ProcedureSmartCookbookSession

Throws:

NotFoundException - procedureBookId not found

NullArgumentException - procedureBookId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProcedureSmartCookbook() is false

Compliance:

optional - This method must be implemented if supportsProcedureSmartCookbook() is true.

getCookbookLookupSession

CookbookLookupSession getCookbookLookupSession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the cook book lookup service.

Parameters:

proxy - a proxy

Returns:

a CookbookLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCookbookLookup() is false

Compliance:

optional - This method must be implemented if supportsCookbookLookup() is true.

getCookbookQuerySession

CookbookQuerySession getCookbookQuerySession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the cook book query service.

Parameters:

proxy - a proxy

Returns:

a CookbookQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCookbookQuery() is false

Compliance:

optional - This method must be implemented if supportsCookbookQuery() is true.

getCookbookSearchSession

CookbookSearchSession getCookbookSearchSession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the cook book search service.

Parameters:

proxy - a proxy

Returns:

a CookbookSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCookbookSearch() is false

Compliance:

optional - This method must be implemented if supportsCookbookSearch() is true.

getCookbookAdminSession

CookbookAdminSession getCookbookAdminSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the cook book administrative service.

Parameters:

proxy - a proxy

Returns:

a CookbookAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCookbookAdmin() is false

Compliance:

optional - This method must be implemented if supportsCookbookAdmin() is true.

getCookbookNotificationSession

CookbookNotificationSession getCookbookNotificationSession(CookbookReceiver cookbookReceiver,
                                                         Proxy proxy)
                                                           throws OperationFailedException

Gets the OsidSession associated with the cook book notification service.

Parameters:

cookbookReceiver - the receiver

proxy - a proxy

Returns:

a CookbookNotificationSession

Throws:

NullArgumentException - cookbookReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCookbookNotification() is false

Compliance:

optional - This method must be implemented if supportsCookbookNotification() is true.

getCookbookHierarchySession

CookbookHierarchySession getCookbookHierarchySession(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the cook book hierarchy service.

Parameters:

proxy - a proxy

Returns:

a CookbookHierarchySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCookbookHierarchy() is false

Compliance:

optional - This method must be implemented if supportsCookbookHierarchy() is true.

getCookbookHierarchyDesignSession

CookbookHierarchyDesignSession getCookbookHierarchyDesignSession(Proxy proxy)
                                                                 throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

a CookbookHierarchyDesignSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCookbookHierarchyDesign() is false

Compliance:

optional - This method must be implemented if supportsCookbookHierarchyDesign() is true.

getRecipeBatchProxyManager

RecipeBatchProxyManager getRecipeBatchProxyManager()
                                                   throws OperationFailedException

Gets the RecipieBatchProxyManager .

Returns:

a RecipeBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRecipeBatch() is false

Compliance:

optional - This method must be implemented if supportsRecipeBatch() is true.