OSID - osid.recipe.DirectionLookupSession Service Interface Definition

Interface	osid.recipe.DirectionLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving directions. 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 isolated cook book view: All direction methods in this session operate, retrieve and pertain to directions defined explicitly in the current cookbook. Using an isolated view is useful for managing `Directions` with the `DirectionAdminSession.` federated cook book view: All direction lookup methods in this session operate, retrieve and pertain to all directions defined in this cook book and any other directions implicitly available in this cook book through cook book inheritence. The methods `useFederatedCookbookView()` and `useIsolatedCookbookView()` behave as a radio group and one should be selected before invoking any lookup methods. Directions may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the `Directions.`
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	canLookupDirections
Description	Tests if this user can perform `Direction` 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 not 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	useComparativeDirectionView
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	usePlenaryDirectionView
Description	A complete view of the `Direction` 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 directions 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 retrievals to this cook book only.
Compliance	`mandatory`		This method is must be implemented.
Method	getDirection
Description	Gets the `Direction` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Direction` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Direction` and retained for compatibility.
Parameters	`osid.id.Id`	`directionId`	the `Id` of the `Direction` to retrieve
Return	`osid.recipe.Direction`		the returned `Direction`
Errors	NOT_FOUND		no `Direction` found with the given `Id`
	NULL_ARGUMENT		`directionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDirectionsByIds
Description	Gets a `DirectionList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the directions 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 `Directions` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`directionIds`	the list of `Ids` to retrieve
Return	`osid.recipe.DirectionList`		the returned `Direction` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`directionIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDirectionsByGenusType
Description	Gets a `DirectionList` corresponding to the given direction genus `Type` which does not include directions of types derived from the specified `Type.` In plenary mode, the returned list contains all known directions or an error results. Otherwise, the returned list may contain only those directions that are accessible through this session.
Parameters	`osid.type.Type`	`directionGenusType`	a direction genus type
Return	`osid.recipe.DirectionList`		the returned `Direction` list
Errors	NULL_ARGUMENT		`directionGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDirectionsByParentGenusType
Description	Gets a `DirectionList` corresponding to the given direction genus `Type` and include any additional directions with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known directions or an error results. Otherwise, the returned list may contain only those directions that are accessible through this session.
Parameters	`osid.type.Type`	`directionGenusType`	a direction genus type
Return	`osid.recipe.DirectionList`		the returned `Direction` list
Errors	NULL_ARGUMENT		`directionGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDirectionsByRecordType
Description	Gets a `DirectionList` containing the given direction record `Type.` In plenary mode, the returned list contains all known directions or an error results. Otherwise, the returned list may contain only those directions that are accessible through this session.
Parameters	`osid.type.Type`	`directionRecordType`	a direction record type
Return	`osid.recipe.DirectionList`		the returned `Direction` list
Errors	NULL_ARGUMENT		`directionRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDirectionsForRecipe
Description	Gets a `DirectionList` for the given recipe `Id.` In plenary mode, the returned list contains all known directions or an error results. Otherwise, the returned list may contain only those directions that are accessible through this session.
Parameters	`osid.id.Id`	`recipeId`	a recipe `Id`
Return	`osid.recipe.DirectionList`		the returned `Direction` list
Errors	NULL_ARGUMENT		`recipeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDirections
Description	Gets all directions. In plenary mode, the returned list contains all of the directions, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `Directions` may be omitted from the list and may present the elements in any order including returning a unique set.
Return	`osid.recipe.DirectionList`		the returned `Direction` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.