OSID - osid.recipe.RecipeLookupSession Service Interface Definition

Interface	osid.recipe.RecipeLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `Recipe` objects. This session defines views that offer differing behaviors when retrieving multiple objects. comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition isolated cook book view: All recipe methods in this session operate, retrieve and pertain to recipes defined explicitly in the current cookbook. Using an isolated view is useful for managing `Recipes` with the `RecipeAdminSession.` federated cook book view: All recipe methods in this session operate, retrieve and pertain to all recipes defined in this cook book and any other recipes implicitly available in this cook book through cook book inheritence. Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods `useFederatedCookbookView()` and `useIsolatedCookbookView()` behave as a radio group and one should be selected before invoking any lookup methods.
Method	getCookbookId
Description	Gets the `Cookbook` `Id` associated with this session.
Return	`osid.id.Id`		the `Cookbook Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCookbook
Description	Gets the `Cookbook` associated with this session.
Return	`osid.recipe.Cookbook`		the cookbook
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupRecipes
Description	Tests if this user can perform `Recipe` lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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.
Return	`boolean`		`false` if lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeRecipeView
Description	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.
Method	usePlenaryRecipeView
Description	A complete view of the `Recipe` 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.
Method	useFederatedCookbookView
Description	Federates the view for methods in this session. A federated view will include recipes in cook books which are children of this cook book in the cook book hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedCookbookView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this cook book only.
Compliance	`mandatory`		This method is must be implemented.
Method	getRecipe
Description	Gets the `Recipe` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Recipe` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Recipe` and retained for compatibility.
Parameters	`osid.id.Id`	`recipeId`	`Id` of the `Recipe`
Return	`osid.recipe.Recipe`		the recipe
Errors	NOT_FOUND		`recipeId` not found
	NULL_ARGUMENT		`recipeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getRecipesByIds
Description	Gets a `RecipeList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the recipes specified in the `Id` list, in the order of the list, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `Recipes` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`recipeIds`	the list of `Ids` to retrieve
Return	`osid.recipe.RecipeList`		the returned `Recipe` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`recipeIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRecipesByGenusType
Description	Gets a `RecipeList` corresponding to the given recipe genus `Type` which does not include recipes of genus types derived from the specified `Type` . In plenary mode, the returned list contains all known recipes or an error results. Otherwise, the returned list may contain only those recipes that are accessible through this session.
Parameters	`osid.type.Type`	`recipeGenusType`	a recipe genus type
Return	`osid.recipe.RecipeList`		the returned `Recipe` list
Errors	NULL_ARGUMENT		`recipeGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRecipesByParentGenusType
Description	Gets a `RecipeList` corresponding to the given recipe genus `Type` and include any additional recipes with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known recipes or an error results. Otherwise, the returned list may contain only those recipes that are accessible through this session.
Parameters	`osid.type.Type`	`recipeGenusType`	a recipe genus type
Return	`osid.recipe.RecipeList`		the returned `Recipe` list
Errors	NULL_ARGUMENT		`recipeGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRecipesByRecordType
Description	Gets a `RecipeList` containing the given recipe record `Type.` In plenary mode, the returned list contains all known recipes or an error results. Otherwise, the returned list may contain only those recipes that are accessible through this session.
Parameters	`osid.type.Type`	`recipeRecordType`	a recipe record type
Return	`osid.recipe.RecipeList`		the returned `Recipe` list
Errors	NULL_ARGUMENT		`recipeRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRecipesByProvider
Description	Gets a `RecipeList` from the given provider `.` In plenary mode, the returned list contains all known recipes or an error results. Otherwise, the returned list may contain only those recipes that are accessible through this session.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.recipe.RecipeList`		the returned `Recipe` list
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRecipes
Description	Gets all `Recipes.` In plenary mode, the returned list contains all known recipes or an error results. Otherwise, the returned list may contain only those recipes that are accessible through this session.
Return	`osid.recipe.RecipeList`		a list of `Recipes`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.