Interface RecipeProxyManager

All Superinterfaces:

AutoCloseable, Closeable, OsidProfile, OsidProxyManager, 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 cookbooks
• RecipeCookbookAssignmentSession : a session to manage recipe to cookbook mappings
• RecipeCookbookAssignmentSession : a session to manage dynamic cookbooks of recipes

• DirectionLookupSession : a session to retrieve directions
• DirectionQuerySession : a session to query for directions
• DirectionSearchSession : a session to search for directions
• DirectionAdminSession : a session to create and delete directions
• DirectionNotificationSession : a session to receive notifications pertaining to direction changes
• DirectionCookbookSession : a session to look up direction cookbook mappings
• DirectionCookbookAssignmentSession : a session to manage direction to cookbook mappings
• DirectionSmartCookbookSession : a session to manage dynamic cookbooks of directions

• ProcedureLookupSession : a session to lookup procedures
• ProcedureQuerySession : a session to query procedures
• ProcedureSearchSession : a session to search procedures
• ProcedureAdminSession : a session to manage procedures
• ProcedureNotificationSession : a session to subscribe to notifications of procedure changes
• ProcedureCookbookSession : a session to lookup procedure cookbook mappings
• ProcedureCookbookAssignmentSession : a session to manage procedure cookbook mappings
• ProcedureSmartCookbookSession : a session to manage smart cookbooks of procedures

• CookbookLookupSession : a session to retrieve cookbooks
• CookbookQuerySession : a session to query cookbooks
• CookbookSearchSession : a session to search for coo books
• CookbookAdminSession : a session to create, update and delete cookbooks
• CookbookNotificationSession : a session to receive notifications for changes in cookbooks
• CookbookHierarchyTraversalSession : a session to traverse hierarchies of cookbooks
• CookbookHierarchyDesignSession : a session to manage hierarchies of cookbooks

Method Summary

Modifier and Type	Method	Description
CookbookAdminSession	getCookbookAdminSession(Proxy proxy)	Gets the OsidSession associated with the cookbook administrative service.
CookbookHierarchyDesignSession	getCookbookHierarchyDesignSession(Proxy proxy)	Gets the OsidSession associated with the cookbook hierarchy design service.
CookbookHierarchySession	getCookbookHierarchySession(Proxy proxy)	Gets the OsidSession associated with the cookbook hierarchy service.
CookbookLookupSession	getCookbookLookupSession(Proxy proxy)	Gets the OsidSession associated with the cookbook lookup service.
CookbookNotificationSession	getCookbookNotificationSession(CookbookReceiver cookbookReceiver, Proxy proxy)	Gets the OsidSession associated with the cookbook notification service.
CookbookQuerySession	getCookbookQuerySession(Proxy proxy)	Gets the OsidSession associated with the cookbook query service.
CookbookSearchSession	getCookbookSearchSession(Proxy proxy)	Gets the OsidSession associated with the cookbook 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 cookbooks.
DirectionCookbookSession	getDirectionCookbookSession(Proxy proxy)	Gets the OsidSession to lookup direction/cookbook 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 cookbooks.
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 cookbook mappings.
ProcedureCookbookSession	getProcedureCookbookSession(Proxy proxy)	Gets the session for retrieving procedure to cookbook 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 cookbook 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 RecipeBatchProxyManager .
RecipeCookbookAssignmentSession	getRecipeCookbookAssignmentSession(Proxy proxy)	Gets the OsidSession associated with assigning recipes to cookbooks.
RecipeCookbookSession	getRecipeCookbookSession(Proxy proxy)	Gets the OsidSession to lookup recipe/cookbook 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 cookbooks.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface OsidProxyManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId, Proxy proxy)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime, Proxy proxy)	Rolls back this service to a point in time.

Methods inherited from interface 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, supportsRecipeBatch, supportsRecipeCookbook, supportsRecipeCookbookAssignment, supportsRecipeLookup, supportsRecipeNotification, supportsRecipeQuery, supportsRecipeRecordType, supportsRecipeSearch, supportsRecipeSearchRecordType, supportsRecipeSmartCookbook, supportsVisibleFederation

Modifier and Type	Method	Description
TypeList	getCookbookRecordTypes()	Gets the supported cookbook record types.
TypeList	getCookbookSearchRecordTypes()	Gets the supported cookbook search record types.
TypeList	getDirectionRecordTypes()	Gets the supported Direction record types.
TypeList	getDirectionSearchRecordTypes()	Gets the supported Direction search types.
TypeList	getIngredientRecordTypes()	Gets the supported Ingredient record types.
TypeList	getProcedureRecordTypes()	Gets the supported Procedure record types.
TypeList	getProcedureSearchRecordTypes()	Gets the supported procedure search record types.
TypeList	getRecipeRecordTypes()	Gets the supported Recipe record types.
TypeList	getRecipeSearchRecordTypes()	Gets the supported Recipe search record types.
boolean	supportsCookbookAdmin()	Tests for the availability of a cookbook administrative service for creating and deleting cookbooks.
boolean	supportsCookbookHierarchy()	Tests for the availability of a cookbook hierarchy traversal service.
boolean	supportsCookbookHierarchyDesign()	Tests for the availability of a cookbook hierarchy design service.
boolean	supportsCookbookLookup()	Tests for the availability of a cookbook lookup service.
boolean	supportsCookbookNotification()	Tests for the availability of a cookbook notification service.
boolean	supportsCookbookQuery()	Tests if querying cookbooks is available.
boolean	supportsCookbookRecordType(Type cookbookRecordType)	Tests if the given cookbook record type is supported.
boolean	supportsCookbookSearch()	Tests if searching for cookbooks is available.
boolean	supportsCookbookSearchRecordType(Type cookbookSearchRecordType)	Tests if the given cookbook search record type is supported.
boolean	supportsDirectionAdmin()	Tests if direction administrative service is supported.
boolean	supportsDirectionCookbook()	Tests if a direction cookbook lookup service is supported.
boolean	supportsDirectionCookbookAssignment()	Tests if a direction cookbook assignment service is supported.
boolean	supportsDirectionLookup()	Tests if looking up directions is supported.
boolean	supportsDirectionNotification()	Tests if a direction notification service is supported.
boolean	supportsDirectionQuery()	Tests if querying directions is supported.
boolean	supportsDirectionRecordType(Type directionRecordType)	Tests if the given Direction record type is supported.
boolean	supportsDirectionSearch()	Tests if searching directions is supported.
boolean	supportsDirectionSearchRecordType(Type directionSearchRecordType)	Tests if the given Direction search type is supported.
boolean	supportsDirectionSmartCookbook()	Tests if a direction smart cookbook service is supported.
boolean	supportsIngredientRecordType(Type ingredientRecordType)	Tests if the given Ingredient record type is supported.
boolean	supportsProcedureAdmin()	Tests if searching for procedures is available.
boolean	supportsProcedureCookbook()	Tests if a procedure to cookbook lookup session is available.
boolean	supportsProcedureCookbookAssignment()	Tests if a procedure to cookbook assignment session is available.
boolean	supportsProcedureLookup()	Tests for the availability of a procedure lookup service.
boolean	supportsProcedureNotification()	Tests if procedure notification is available.
boolean	supportsProcedureQuery()	Tests if querying procedures is available.
boolean	supportsProcedureRecordType(Type procedureRecordType)	Tests if the given Procedure record type is supported.
boolean	supportsProcedureSearch()	Tests if searching for procedures is available.
boolean	supportsProcedureSearchRecordType(Type procedureSearchRecordType)	Tests if the given procedure search record type is supported.
boolean	supportsProcedureSmartCookbook()	Tests if a procedure smart cookbook session is available.
boolean	supportsRecipeAdmin()	Tests if recipe administrative service is supported.
boolean	supportsRecipeBatch()	Tests for the availability of a batch recipe service.
boolean	supportsRecipeCookbook()	Tests if a recipe cookbook lookup service is supported.
boolean	supportsRecipeCookbookAssignment()	Tests if a recipe cookbook service is supported.
boolean	supportsRecipeLookup()	Tests if looking up recipes is supported.
boolean	supportsRecipeNotification()	Tests if a recipe notification service is supported.
boolean	supportsRecipeQuery()	Tests if querying recipes is supported.
boolean	supportsRecipeRecordType(Type recipeRecordType)	Tests if the given Recipe record type is supported.
boolean	supportsRecipeSearch()	Tests if searching recipes is supported.
boolean	supportsRecipeSearchRecordType(Type recipeSearchRecordType)	Tests if the given Recipe search record type is supported.
boolean	supportsRecipeSmartCookbook()	Tests if a recipe smart cookbook lookup service is supported.
boolean	supportsVisibleFederation()	Tests if any cookbook federation is exposed.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

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 {@code supportsRecipeLookup()} is {@code 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 {@code supportsRecipeLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsRecipeQuery()} is {@code 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 cookbook 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 {@code supportsRecipeQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsRecipeSearch()} is {@code 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 cookbook 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 {@code supportsRecipeSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsRecipeAdmin()} is {@code 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 cookbook 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 {@code supportsRecipeAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsRecipeNotification()} is {@code 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 cookbook 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 {@code supportsRecipeNotification()} and {@code supportsVisibleFederation()} are {@code true}

getRecipeCookbookSession

RecipeCookbookSession getRecipeCookbookSession(Proxy proxy)
                                        throws OperationFailedException

Gets the OsidSession to lookup recipe/cookbook 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 {@code supportsRecipeCookbook()} is {@code true} .

getRecipeCookbookAssignmentSession

RecipeCookbookAssignmentSession getRecipeCookbookAssignmentSession(Proxy proxy)
                                                            throws OperationFailedException

Gets the OsidSession associated with assigning recipes to cookbooks.

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 {@code supportsRecipeCookbookAssignment()} is {@code true} .

getRecipeSmartCookbookSession

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

Gets the OsidSession to manage recipe smart cookbooks.

Parameters:

cookbookId - the Id of the Cookbook

proxy - a proxy

Returns:

a RecipeSmartCookbookSession

Throws:

NotFoundException - no cookbook 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 {@code supportsRecipeSmartCookbook()} is {@code 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 {@code supportsDirectionLookup()} is {@code 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 cookbook

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 {@code supportsDirectionLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsDirectionQuery()} is {@code 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 Cookbook 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 {@code supportsDirectionQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsDirectionSearch()} is {@code 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 Cookbook 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 {@code supportsDirectionSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsDirectionAdmin()} is {@code 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 Cookbook 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 {@code supportsDirectionAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsDirectionNotification()} is {@code 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 Cookbook 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 {@code supportsDirectionNotification()} and {@code supportsVisibleFederation()} are {@code true}

getDirectionCookbookSession

DirectionCookbookSession getDirectionCookbookSession(Proxy proxy)
                                              throws OperationFailedException

Gets the OsidSession to lookup direction/cookbook 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 {@code supportsDirectionCookbook()} is {@code true} .

getDirectionCookbookAssignmentSession

DirectionCookbookAssignmentSession getDirectionCookbookAssignmentSession(Proxy proxy)
                                                                  throws OperationFailedException

Gets the OsidSession associated with assigning mappings to cookbooks.

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 {@code supportsDirectionCookbookAssignment()} is {@code true} .

getDirectionSmartCookbookSession

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

Gets the OsidSession to manage locatin smart cookbooks.

Parameters:

cookbookId - the Id of the Cookbook

proxy - a proxy

Returns:

a DirectionSmartCookbookSession

Throws:

NotFoundException - no cookbook 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 {@code supportsDirectionSmartCookbook()} is {@code 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 {@code supportsProcedureLookup()} is {@code 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 {@code supportsProcedureLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsProcedureQuery()} is {@code 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 {@code supportsProcedureQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsProcedureSearch()} is {@code 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 {@code supportsProcedureSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsProcedureAdmin()} is {@code 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 {@code supportsProcedureAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsProcedureNotification()} is {@code 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 {@code supportsProcedureNotification()} and {@code supportsVisibleFederation()} are {@code true}

getProcedureCookbookSession

ProcedureCookbookSession getProcedureCookbookSession(Proxy proxy)
                                              throws OperationFailedException

Gets the session for retrieving procedure to cookbook 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 {@code supportsProcedureCookbook()} is {@code true} .

getProcedureCookbookAssignmentSession

ProcedureCookbookAssignmentSession getProcedureCookbookAssignmentSession(Proxy proxy)
                                                                  throws OperationFailedException

Gets the session for assigning procedure to cookbook 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 {@code supportsProcedureCookbookAssignment()} is {@code true} .

getProcedureSmartCookbookSession

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

Gets the session associated with the procedure smart cookbook 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 {@code supportsProcedureSmartCookbook()} is {@code true} .

getCookbookLookupSession

CookbookLookupSession getCookbookLookupSession(Proxy proxy)
                                        throws OperationFailedException

Gets the OsidSession associated with the cookbook 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 {@code supportsCookbookLookup()} is {@code true} .

getCookbookQuerySession

CookbookQuerySession getCookbookQuerySession(Proxy proxy)
                                      throws OperationFailedException

Gets the OsidSession associated with the cookbook 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 {@code supportsCookbookQuery()} is {@code true} .

getCookbookSearchSession

CookbookSearchSession getCookbookSearchSession(Proxy proxy)
                                        throws OperationFailedException

Gets the OsidSession associated with the cookbook 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 {@code supportsCookbookSearch()} is {@code true} .

getCookbookAdminSession

CookbookAdminSession getCookbookAdminSession(Proxy proxy)
                                      throws OperationFailedException

Gets the OsidSession associated with the cookbook 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 {@code supportsCookbookAdmin()} is {@code true} .

getCookbookNotificationSession

CookbookNotificationSession getCookbookNotificationSession(CookbookReceiver cookbookReceiver,
 Proxy proxy)
                                                    throws OperationFailedException

Gets the OsidSession associated with the cookbook 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 {@code supportsCookbookNotification()} is {@code true} .

getCookbookHierarchySession

CookbookHierarchySession getCookbookHierarchySession(Proxy proxy)
                                              throws OperationFailedException

Gets the OsidSession associated with the cookbook 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 {@code supportsCookbookHierarchy()} is {@code true} .

getCookbookHierarchyDesignSession

CookbookHierarchyDesignSession getCookbookHierarchyDesignSession(Proxy proxy)
                                                          throws OperationFailedException

Gets the OsidSession associated with the cookbook 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 {@code supportsCookbookHierarchyDesign()} is {@code true} .

getRecipeBatchProxyManager

RecipeBatchProxyManager getRecipeBatchProxyManager()
                                            throws OperationFailedException

Gets the RecipeBatchProxyManager .

Returns:

a RecipeBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRecipeBatch() is false

Compliance:

optional - This method must be implemented if {@code supportsRecipeBatch()} is {@code true} .