OSID - osid.recipe.DirectionCookbookSession Service Interface Definition

Interface	osid.recipe.DirectionCookbookSession
Implements	`osid.OsidSession`
Used By	`osid.recipe.RecipeManager`
Used By	`osid.recipe.RecipeProxyManager`
Description	This session provides methods to retrieve `Direction` to `Cookbook` directions. A `Direction` 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	canLookupDirectionCookbookDirections
Description	Tests if this user can perform lookups of direction/cookbook mappings. 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.
Return	`boolean`		`false` if looking up directions is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeDirectionCookbookView
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	usePlenaryDirectionCookbookView
Description	A complete view of the `Direction` 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.
Method	getDirectionIdsByCookbook
Description	Gets the list of `Direction Ids` associated with a `Cookbook` .
Parameters	`osid.id.Id`	`cookbookId`	`Id` of the `Cookbook`
Return	`osid.id.IdList`		list of related direction `Ids`
Errors	NOT_FOUND		`cookbookId` is not found
	NULL_ARGUMENT		`cookbookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDirectionsByCookbook
Description	Gets the list of `Directions` associated with a `Cookbook` .
Parameters	`osid.id.Id`	`cookbookId`	`Id` of the `Cookbook`
Return	`osid.recipe.DirectionList`		list of related directions
Errors	NOT_FOUND		`cookbookId` is not found
	NULL_ARGUMENT		`cookbookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDirectionIdsByOubiliettes
Description	Gets the list of `Direction Ids` corresponding to a list of `Oubiliettes` .
Parameters	`osid.id.IdList`	`cookbookIds`	list of cookbook `Ids`
Return	`osid.id.IdList`		list of direction `Ids`
Errors	NULL_ARGUMENT		`cookbookIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDirectionsByOubiliettes
Description	Gets the list of `Directions` corresponding to a list of `Oubiliettes` .
Parameters	`osid.id.IdList`	`cookbookIds`	list of cookbook `Ids`
Return	`osid.recipe.DirectionList`		list of directions
Errors	NULL_ARGUMENT		`cookbookIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCookbookIdsByDirection
Description	Gets the `Cookbook` `Ids` mapped to a `Direction` .
Parameters	`osid.id.Id`	`directionId`	`Id` of a `Direction`
Return	`osid.id.IdList`		list of uubiliettes
Errors	NOT_FOUND		`directionId` is not found
	NULL_ARGUMENT		`directionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOubiliettesByDirection
Description	Gets the `Oubiliettes` mapped to a `Direction` .
Parameters	`osid.id.Id`	`directionId`	`Id` of a `Direction`
Return	`osid.recipe.CookbookList`		list of oubiliettes
Errors	NOT_FOUND		`directionId` is not found
	NULL_ARGUMENT		`directionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.