OSID - osid.inventory.StockHierarchySession Service Interface Definition

Interface	osid.inventory.StockHierarchySession
Implements	`osid.OsidSession`
Description	This session defines methods for traversing a hierarchy of `Stock` objects. Each node in the hierarchy is a unique `Stock.` The hierarchy may be traversed recursively to establish the tree structure through `getParentStocks()` and `getChildStocks().` To relate these `Ids` to another OSID, `getStockNodes()` can be used for retrievals that can be used for bulk lookups in other OSIDs. Any `Stock` available in the Inventory 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 `getParentStocks()` or `getChildStocks()` 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: stock elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition
Method	getStockHierarchyId
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	getStockHierarchy
Description	Gets the hierarchy associated with this session.
Return	`osid.hierarchy.Hierarchy`		the stock hierarchy
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canAccessStockHierarchy
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	useComparativeStockView
Description	The returns from the stock 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	usePlenaryStockView
Description	A complete view of the `Stocks` 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	getRootStockIds
Description	Gets the root stock `Ids` in this hierarchy.
Return	`osid.id.IdList`		the root stock `Ids`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRootStocks
Description	Gets the root stocks in the stock hierarchy. A node with no parents is an orphan. While all stock 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.inventory.StockList`		the root stocks
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	hasParentStocks
Description	Tests if the `Stock` has any parents.
Parameters	`osid.id.Id`	`stockId`	a stock `Id`
Return	`boolean`		`true` if the stock has parents, f `alse` otherwise
Errors	NOT_FOUND		`stockId` is not found
	NULL_ARGUMENT		`stockId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isParentOfStock
Description	Tests if an `Id` is a direct parent of stock.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`stockId`	the `Id` of a stock
Return	`boolean`		`true` if this `id` is a parent of `stockId,` f `alse` otherwise
Errors	NOT_FOUND		`stockId` is not found
	NULL_ARGUMENT		`id` or `stockId` 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	getParentStockIds
Description	Gets the parent `Ids` of the given stock.
Parameters	`osid.id.Id`	`stockId`	a stock `Id`
Return	`osid.id.IdList`		the parent Ids of the stock
Errors	NOT_FOUND		`stockId` is not found
	NULL_ARGUMENT		`stockId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParentStocks
Description	Gets the parents of the given stock.
Parameters	`osid.id.Id`	`stockId`	the `Id` to query
Return	`osid.inventory.StockList`		the parents of the stock
Errors	NOT_FOUND		`stockId` not found
	NULL_ARGUMENT		`stockId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isAncestorOfStock
Description	Tests if an `Id` is an ancestor of a stock.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`stockId`	the `Id` of a stock
Return	`boolean`		`tru` e if this `id` is an ancestor of `stockId,` `false` otherwise
Errors	NOT_FOUND		`stockId` not found
	NULL_ARGUMENT		`stockId` or `id` 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	hasChildStocks
Description	Tests if a stock has any children.
Parameters	`osid.id.Id`	`stockId`	a stock `Id`
Return	`boolean`		`true` if the `stockId` has children, `false` otherwise
Errors	NOT_FOUND		`stockId` not found
	NULL_ARGUMENT		`stockId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isChildOfStock
Description	Tests if a stock is a direct child of another.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`stockId`	the `Id` of a stock
Return	`boolean`		`true` if the `id` is a child of `stockId,` `false` otherwise
Errors	NOT_FOUND		`stockId` not found
	NULL_ARGUMENT		`id` or `stockId` 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	getChildStockIds
Description	Gets the child `Ids` of the given stock.
Parameters	`osid.id.Id`	`stockId`	the `Id` to query
Return	`osid.id.IdList`		the children of the stock
Errors	NOT_FOUND		`stockId` not found
	NULL_ARGUMENT		`stockId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getChildStocks
Description	Gets the children of the given stock.
Parameters	`osid.id.Id`	`stockId`	the `Id` to query
Return	`osid.inventory.StockList`		the children of the stock
Errors	NOT_FOUND		`stockId` not found
	NULL_ARGUMENT		`stockId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isDescendantOfStock
Description	Tests if an `Id` is a descendant of a stock.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`stockId`	the `Id` of a stock
Return	`boolean`		`true` if the `id` is a descendant of the `stockId,` `false` otherwise
Errors	NOT_FOUND		`stockId` not found
	NULL_ARGUMENT		`id` or `stockId` 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	getStockNodeIds
Description	Gets a portion of the hierarchy for the given stock.
Parameters	`osid.id.Id`	`stockId`	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 stock node
Errors	NOT_FOUND		`stockId` not found
	NULL_ARGUMENT		`stockId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getStockNodes
Description	Gets a portion of the hierarchy for the given stock.
Parameters	`osid.id.Id`	`stockId`	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.inventory.StockNode`		a stock node
Errors	NOT_FOUND		`stockId` not found
	NULL_ARGUMENT		`stockId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.