OSID - osid.recipe.CookbookHierarchySession Service Interface Definition

Interface	osid.recipe.CookbookHierarchySession
Implements	`osid.OsidSession`
Description	This session defines methods for traversing a hierarchy of `Cookbook` objects. Each node in the hierarchy is a unique `Cookbook.` The hierarchy may be traversed recursively to establish the tree structure through `getParentCookbooks()` and `getChildCookbooks().` To relate these `Ids` to another OSID, `getCookbookNodes()` can be used for retrievals that can be used for bulk lookups in other OSIDs. Any `Cookbook` available in the Procedure OSID is known to this hierarchy but does not appear in the hierarchy traversal until added as a root node or a child of another node. A user may not be authorized to traverse the entire hierarchy. Parts of the hierarchy may be made invisible through omission from the returns of `getParentCookbooks()` or `getChildCookbooks()` in lieu of a `PERMISSION_DENIED` error that may disrupt the traversal through authorized pathways. This session defines views that offer differing behaviors when retrieving multiple objects. comparative view: cook book elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition
Method	getCookbookHierarchyId
Description	Gets the hierarchy `Id` associated with this session.
Return	`osid.id.Id`		the hierarchy `Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCookbookHierarchy
Description	Gets the hierarchy associated with this session.
Return	`osid.hierarchy.Hierarchy`		the hierarchy associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canAccessCookbookHierarchy
Description	Tests if this user can perform hierarchy queries. 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.
Return	`boolean`		`false` if hierarchy traversal methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeCookbookView
Description	The returns from the cook book 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	usePlenaryCookbookView
Description	A complete view of the `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	getRootCookbookIds
Description	Gets the root cook book `Ids` in this hierarchy.
Return	`osid.id.IdList`		the root cook book `Ids`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRootCookbooks
Description	Gets the root cook books in the cook book hierarchy. A node with no parents is an orphan. While all cook book `Ids` are known to the hierarchy, an orphan does not appear in the hierarchy unless explicitly added as a root node or child of another node.
Return	`osid.recipe.CookbookList`		the root cook books
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	hasParentCookbooks
Description	Tests if the `Cookbook` has any parents.
Parameters	`osid.id.Id`	`cookbookId`	a cook book `Id`
Return	`boolean`		`true` if the cook book has parents, f `alse` otherwise
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	isParentOfCookbook
Description	Tests if an `Id` is a direct parent of cookbook.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`cookbookId`	the `Id` of a cookbook
Return	`boolean`		`true` if this `id` is a parent of `cookbookId,` f `alse` otherwise
Errors	NOT_FOUND		`cookbookId` is not found
	NULL_ARGUMENT		`id` or `cookbookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If `id` not found return `false.`
Method	getParentCookbookIds
Description	Gets the parent `Ids` of the given cookbook.
Parameters	`osid.id.Id`	`cookbookId`	a cook book `Id`
Return	`osid.id.IdList`		the parent `Ids` of the cookbook
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	getParentCookbooks
Description	Gets the parent cook books of the given `id.`
Parameters	`osid.id.Id`	`cookbookId`	the `Id` of the `Cookbook` to query
Return	`osid.recipe.CookbookList`		the parent cook books of the `id`
Errors	NOT_FOUND		an `Cookbook` identified by `Id 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	isAncestorOfCookbook
Description	Tests if an `Id` is an ancestor of a cookbook.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`cookbookId`	the `Id` of a cookbook
Return	`boolean`		`tru` e if this `id` is an ancestor of `cookbookId,` `false` otherwise
Errors	NOT_FOUND		`cookbookId` is not found
	NULL_ARGUMENT		`id` or `cookbookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If `id` not found return `false.`
Method	hasChildCookbooks
Description	Tests if a cook book has any children.
Parameters	`osid.id.Id`	`cookbookId`	a cook book `Id`
Return	`boolean`		`true` if the `cookbookId` has children, `false` otherwise
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	isChildOfCookbook
Description	Tests if a cook book is a direct child of another.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`cookbookId`	the `Id` of a cookbook
Return	`boolean`		`true` if the `id` is a child of `cookbookId,` `false` otherwise
Errors	NOT_FOUND		`cookbookId` is not found
	NULL_ARGUMENT		`id` or `cookbookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If `id` not found return `false.`
Method	getChildCookbookIds
Description	Gets the child `Ids` of the given cookbook.
Parameters	`osid.id.Id`	`cookbookId`	the `Id` to query
Return	`osid.id.IdList`		the children of the cookbook
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	getChildCookbooks
Description	Gets the child cook books of the given `id.`
Parameters	`osid.id.Id`	`cookbookId`	the `Id` of the `Cookbook` to query
Return	`osid.recipe.CookbookList`		the child cook books of the `id`
Errors	NOT_FOUND		an `Cookbook` identified by `Id 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	isDescendantOfCookbook
Description	Tests if an `Id` is a descendant of a cookbook.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`cookbookId`	the `Id` of a cookbook
Return	`boolean`		`true` if the `id` is a descendant of the `cookbookId,` `false` otherwise
Errors	NOT_FOUND		`cookbookId` is not found
	NULL_ARGUMENT		`id` or `cookbookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If `id` is not found return `false.`
Method	getCookbookNodeIds
Description	Gets a portion of the hierarchy for the given cookbook.
Parameters	`osid.id.Id`	`cookbookId`	the `Id` to query
	`cardinal`	`ancestorLevels`	the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.
	`cardinal`	`descendantLevels`	the maximum number of descendant levels to include. A value of 0 returns no children in the node.
	`boolean`	`includeSiblings`	`true` to include the siblings of the given node, `false` to omit the siblings
Return	`osid.hierarchy.Node`		a cook book node
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	getCookbookNodes
Description	Gets a portion of the hierarchy for the given cookbook.
Parameters	`osid.id.Id`	`cookbookId`	the `Id` to query
	`cardinal`	`ancestorLevels`	the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.
	`cardinal`	`descendantLevels`	the maximum number of descendant levels to include. A value of 0 returns no children in the node.
	`boolean`	`includeSiblings`	`true` to include the siblings of the given node, `false` to omit the siblings
Return	`osid.recipe.CookbookNode`		a cook book node
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.