OSID - osid.inventory.StockHierarchyDesignSession Service Interface Definition

Interface	osid.inventory.StockHierarchyDesignSession
Implements	`osid.OsidSession`
Description	This session defines methods for managing a hierarchy of `Stock` objects. Each node in the hierarchy is a unique `Stock.`
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	canModifyStockHierarchy
Description	Tests if this user can change the hierarchy. A return of true does not guarantee successful authorization. A return of false indicates that it is known performing any update will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer these operations to an unauthorized user.
Return	`boolean`		`false` if changing this hierarchy is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	addRootStock
Description	Adds a root stock.
Parameters	`osid.id.Id`	`stockId`	the `Id` of a stock
Errors	ALREADY_EXISTS		`stockId` is already in hierarchy
	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	removeRootStock
Description	Removes a stock.
Parameters	`osid.id.Id`	`stockId`	the `Id` of a stock
Errors	NOT_FOUND		`stockId` not a root
	NULL_ARGUMENT		`stockId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	addChildStock
Description	Adds a child to a stock.
Parameters	`osid.id.Id`	`stockId`	the `Id` of a stock
Parameters	`osid.id.Id`	`childId`	the `Id` of the new child
Errors	ALREADY_EXISTS		`stockId` is already a parent of `childId`
	NOT_FOUND		`stockId` or `childId` not found
	NULL_ARGUMENT		`stockId` or `childId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	removeChildStock
Description	Removes a child from a stock.
Parameters	`osid.id.Id`	`stockId`	the `Id` of a stock
Parameters	`osid.id.Id`	`childId`	the `Id` of the new child
Errors	NOT_FOUND		`stockId` is not a parent of `childId`
	NULL_ARGUMENT		`stockId` or `childId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	removeChildStocks
Description	Removes all children from a stock.
Parameters	`osid.id.Id`	`stockId`	the `Id` of a stock
Errors	NOT_FOUND		`stockId` is in hierarchy
	NULL_ARGUMENT		`stockId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.