Interface RecipeCookbookSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface RecipeCookbookSession
extends OsidSession

This session provides methods to retrieve Recipe to Cookbook ingredients. A Recipe may appear in multiple Cookbook catalogs. Each cookbook may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition

Method Summary

Modifier and Type	Method	Description
boolean	canLookupRecipeCookbookMappings()	Tests if this user can perform lookups of recipe/cookbook ingredients.
IdList	getCookbookIdsByRecipe(Id recipeId)	Gets the Cookbook Ids mapped to a Recipe .
CookbookList	getCookbooksByRecipe(Id recipeId)	Gets the Cookbooks mapped to a Recipe .
IdList	getRecipeIdsByCookbook(Id cookbookId)	Gets the list of Recipe Ids associated with a Cookbook .
IdList	getRecipeIdsByCookbooks(IdList cookbookIds)	Gets the list of Recipe Ids corresponding to a list of Cookbooks .
RecipeList	getRecipesByCookbook(Id cookbookId)	Gets the list of Recipes associated with a Cookbook .
RecipeList	getRecipesByCookbooks(IdList cookbookIds)	Gets the list of Recipe corresponding to a list of Cookbooks .
void	useComparativeRecipeCookbookView()	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryRecipeCookbookView()	A complete view of the Recipe and Cookbook returns is desired.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

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

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

canLookupRecipeCookbookMappings

boolean canLookupRecipeCookbookMappings()

Tests if this user can perform lookups of recipe/cookbook ingredients. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeRecipeCookbookView

void useComparativeRecipeCookbookView()

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryRecipeCookbookView

void usePlenaryRecipeCookbookView()

A complete view of the Recipe and Cookbook returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

getRecipeIdsByCookbook

IdList getRecipeIdsByCookbook(Id cookbookId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Recipe Ids associated with a Cookbook .

Parameters:

cookbookId - Id of the Cookbook

Returns:

list of related recipe Ids

Throws:

NotFoundException - cookbookId is not found

NullArgumentException - cookbookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRecipesByCookbook

RecipeList getRecipesByCookbook(Id cookbookId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Recipes associated with a Cookbook .

Parameters:

cookbookId - Id of the Cookbook

Returns:

list of related recipes

Throws:

NotFoundException - cookbookId is not found

NullArgumentException - cookbookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRecipeIdsByCookbooks

IdList getRecipeIdsByCookbooks(IdList cookbookIds)
                        throws OperationFailedException,
PermissionDeniedException

Gets the list of Recipe Ids corresponding to a list of Cookbooks .

Parameters:

cookbookIds - list of cookbook Ids

Returns:

list of recipe Ids

Throws:

NullArgumentException - cookbookIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRecipesByCookbooks

RecipeList getRecipesByCookbooks(IdList cookbookIds)
                          throws OperationFailedException,
PermissionDeniedException

Gets the list of Recipe corresponding to a list of Cookbooks .

Parameters:

cookbookIds - list of cookbook Ids

Returns:

list of recipes

Throws:

NullArgumentException - cookbookIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCookbookIdsByRecipe

IdList getCookbookIdsByRecipe(Id recipeId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Cookbook Ids mapped to a Recipe .

Parameters:

recipeId - Id of a Recipe

Returns:

list of cookbooks

Throws:

NotFoundException - recipeId is not found

NullArgumentException - recipeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCookbooksByRecipe

CookbookList getCookbooksByRecipe(Id recipeId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Cookbooks mapped to a Recipe .

Parameters:

recipeId - Id of a Recipe

Returns:

list of cookbooks

Throws:

NotFoundException - recipeId is not found

NullArgumentException - recipeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.