org.osid.recipe

Interface RecipeManager

All Superinterfaces:

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

public interface RecipeManager
extends OsidManager, RecipeProfile

The recipe manager provides access to procedure sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

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

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

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

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()
                                           throws OperationFailedException

Gets the OsidSession associated with the recipe lookup service.

Returns:

a RecipeLookupSession

Throws:

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)
                                                      throws NotFoundException,
                                                             OperationFailedException

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

Parameters:

cookbookId - the Id of the Cookbook

Returns:

q RecipeLookupSession

Throws:

NotFoundException - no Cookbook found by the given Id

NullArgumentException - cookbookId 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()
                                         throws OperationFailedException

Gets the OsidSession associated with the recipe query service.

Returns:

a RecipeQuerySession

Throws:

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)
                                                    throws NotFoundException,
                                                           OperationFailedException

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

Parameters:

cookbookId - the Id of the Cookbook

Returns:

a RecipeQuerySession

Throws:

NotFoundException - no cook book found by the given Id

NullArgumentException - cookbookId 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()
                                           throws OperationFailedException

Gets the OsidSession associated with the recipe search service.

Returns:

a RecipeSearchSession

Throws:

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)
                                                      throws NotFoundException,
                                                             OperationFailedException

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

Parameters:

cookbookId - the Id of the Cookbook

Returns:

a RecipeSearchSession

Throws:

NotFoundException - no cook book found by the given Id

NullArgumentException - cookbookId 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()
                                         throws OperationFailedException

Gets the OsidSession associated with the recipe administration service.

Returns:

a RecipeAdminSession

Throws:

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)
                                                    throws NotFoundException,
                                                           OperationFailedException

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

Parameters:

cookbookId - the Id of the Cookbook

Returns:

a RecipeAdminSession

Throws:

NotFoundException - no cook book found by the given Id

NullArgumentException - cookbookId 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)
                                                       throws OperationFailedException

Gets the OsidSession associated with the recipe notification service.

Parameters:

recipeReceiver - the notification callback

Returns:

a RecipeNotificationSession

Throws:

NullArgumentException - recipeReceiver 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)
                                                                  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

Returns:

a RecipeNotificationSession

Throws:

NotFoundException - no cook book found by the given Id

NullArgumentException - recipeReceiver or cookbookId 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()
                                               throws OperationFailedException

Gets the OsidSession to lookup recipe/cook book mappings.

Returns:

a RecipeCookbookSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRecipeCookbook() is false

Compliance:

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

getRecipeCookbookAssignmentSession

RecipeCookbookAssignmentSession getRecipeCookbookAssignmentSession()
                                                                   throws OperationFailedException

Gets the OsidSession associated with assigning recipes to cook books.

Returns:

a RecipeCookbookAssignmentSession

Throws:

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)
                                                         throws NotFoundException,
                                                                OperationFailedException

Gets the OsidSession to manage recipe smart cook books.

Parameters:

cookbookId - the Id of the Cookbook

Returns:

a RecipeSmartCookbookSession

Throws:

NotFoundException - no Cookbook found by the given Id

NullArgumentException - cookbookId 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()
                                                 throws OperationFailedException

Gets the OsidSession associated with the direction lookup service.

Returns:

a DirectionLookupSession

Throws:

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)
                                                            throws NotFoundException,
                                                                   OperationFailedException

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

Parameters:

cookbookId - the Id of the cook book

Returns:

a DirectionLookupSession

Throws:

NotFoundException - no Cookbook found by the given Id

NullArgumentException - cookbookId 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()
                                               throws OperationFailedException

Gets the OsidSession associated with the direction query service.

Returns:

a DirectionQuerySession

Throws:

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)
                                                          throws NotFoundException,
                                                                 OperationFailedException

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

Parameters:

cookbookId - the Id of the Cookbook

Returns:

a DirectionQuerySession

Throws:

NotFoundException - no cook book found by the given Id

NullArgumentException - cookbookId 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()
                                                 throws OperationFailedException

Gets the OsidSession associated with the direction search service.

Returns:

a DirectionSearchSession

Throws:

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)
                                                            throws NotFoundException,
                                                                   OperationFailedException

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

Parameters:

cookbookId - the Id of the Cookbook

Returns:

a DirectionSearchSession

Throws:

NotFoundException - no cook book found by the given Id

NullArgumentException - cookbookId 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()
                                               throws OperationFailedException

Gets the OsidSession associated with the direction administration service.

Returns:

a DirectionAdminSession

Throws:

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)
                                                          throws NotFoundException,
                                                                 OperationFailedException

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

Parameters:

cookbookId - the Id of the Cookbook

Returns:

a DirectionAdminSession

Throws:

NotFoundException - no cook book found by the given Id

NullArgumentException - cookbookId 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)
                                                             throws OperationFailedException

Gets the OsidSession associated with the direction notification service.

Parameters:

directionReceiver - the notification callback

Returns:

a DirectionNotificationSession

Throws:

NullArgumentException - directionReceiver 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)
                                                                        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

Returns:

a DirectionNotificationSession

Throws:

NotFoundException - no cook book found by the given Id

NullArgumentException - directionReceiver or cookbookId 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()
                                                     throws OperationFailedException

Gets the OsidSession to lookup direction/cook book ingredients.

Returns:

a DirectionCookbookSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDirectionCookbook() is false

Compliance:

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

getDirectionCookbookAssignmentSession

DirectionCookbookAssignmentSession getDirectionCookbookAssignmentSession()
                                                                         throws OperationFailedException

Gets the OsidSession associated with assigning directions to cook books.

Returns:

a DirectionCookbookAssignmentSession

Throws:

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)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the OsidSession to manage locatin smart cook books.

Parameters:

cookbookId - the Id of the Cookbook

Returns:

a DirectionSmartCookbookSession

Throws:

NotFoundException - no cook book found by the given Id

NullArgumentException - cookbookId 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()
                                                 throws OperationFailedException

Gets the OsidSession associated with the procedure lookup service.

Returns:

a ProcedureLookupSession

Throws:

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)
                                                            throws NotFoundException,
                                                                   OperationFailedException

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

Parameters:

cookbookId - the Id of the Cookbook

Returns:

a ProcedureLookupSession

Throws:

NotFoundException - no Cookbook found by the given Id

NullArgumentException - cookbookId 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()
                                               throws OperationFailedException

Gets the OsidSession associated with the procedure query service.

Returns:

a ProcedureQuerySession

Throws:

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)
                                                          throws NotFoundException,
                                                                 OperationFailedException

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

Parameters:

cookbookId - the Id of the Cookbook

Returns:

a ProcedureQuerySession

Throws:

NotFoundException - no Cookbook found by the given Id

NullArgumentException - cookbookId 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()
                                                 throws OperationFailedException

Gets the OsidSession associated with the procedure search service.

Returns:

a ProcedureSearchSession

Throws:

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)
                                                            throws NotFoundException,
                                                                   OperationFailedException

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

Parameters:

cookbookId - the Id of the Cookbook

Returns:

a ProcedureSearchSession

Throws:

NotFoundException - no Cookbook found by the given Id

NullArgumentException - cookbookId 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()
                                               throws OperationFailedException

Gets the OsidSession associated with the procedure administration service.

Returns:

a ProcedureAdminSession

Throws:

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)
                                                          throws NotFoundException,
                                                                 OperationFailedException

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

Parameters:

cookbookId - the Id of the Cookbook

Returns:

a ProcedureAdminSession

Throws:

NotFoundException - no Cookbook found by the given Id

NullArgumentException - cookbookId 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)
                                                             throws OperationFailedException

Gets the OsidSession associated with the procedure notification service.

Parameters:

procedureReceiver - the receiver

Returns:

a ProcedureNotificationSession

Throws:

NullArgumentException - procedureReceiver 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)
                                                                        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

Returns:

a ProcedureNotificationSession

Throws:

NotFoundException - no Cookbook found by the given Id

NullArgumentException - procedureReceiver or cookbookId 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()
                                                     throws OperationFailedException

Gets the session for retrieving procedure to cook book mappings.

Returns:

a ProcedureCookbookSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProcedureCookbook() is false

Compliance:

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

getProcedureCookbookAssignmentSession

ProcedureCookbookAssignmentSession getProcedureCookbookAssignmentSession()
                                                                         throws OperationFailedException

Gets the session for assigning procedure to cook book mappings.

Returns:

a ProcedureCookbookAssignmentSession

Throws:

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)
                                                               throws NotFoundException,
                                                                      OperationFailedException

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

Parameters:

cookbookId - the Id of the cookbook

Returns:

a ProcedureSmartCookbookSession

Throws:

NotFoundException - procedureBookId not found

NullArgumentException - procedureBookId 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()
                                               throws OperationFailedException

Gets the OsidSession associated with the cook book lookup service.

Returns:

a CookbookLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCookbookLookup() is false

Compliance:

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

getCookbookQuerySession

CookbookQuerySession getCookbookQuerySession()
                                             throws OperationFailedException

Gets the OsidSession associated with the cook book query service.

Returns:

a CookbookQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCookbookQuery() is false

Compliance:

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

getCookbookSearchSession

CookbookSearchSession getCookbookSearchSession()
                                               throws OperationFailedException

Gets the OsidSession associated with the cook book search service.

Returns:

a CookbookSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCookbookSearch() is false

Compliance:

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

getCookbookAdminSession

CookbookAdminSession getCookbookAdminSession()
                                             throws OperationFailedException

Gets the OsidSession associated with the cook book administrative service.

Returns:

a CookbookAdminSession

Throws:

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)
                                                           throws OperationFailedException

Gets the OsidSession associated with the cook book notification service.

Parameters:

cookbookReceiver - the receiver

Returns:

a CookbookNotificationSession

Throws:

NullArgumentException - cookbookReceiver 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()
                                                     throws OperationFailedException

Gets the OsidSession associated with the cook book hierarchy service.

Returns:

a CookbookHierarchySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCookbookHierarchy() is false

Compliance:

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

getCookbookHierarchyDesignSession

CookbookHierarchyDesignSession getCookbookHierarchyDesignSession()
                                                                 throws OperationFailedException

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

Returns:

a CookbookHierarchyDesignSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCookbookHierarchyDesign() is false

Compliance:

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

getRecipeBatchManager

RecipeBatchManager getRecipeBatchManager()
                                         throws OperationFailedException

Gets the RecipieBatchManager .

Returns:

a RecipeBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRecipeBatch() is false

Compliance:

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