OSID - osid.hierarchy.HierarchyDesignSession Service Interface Definition

Interface	osid.hierarchy.HierarchyDesignSession
Implements	`osid.OsidSession`
Used By	`osid.hierarchy.HierarchyManager`
Used By	`osid.hierarchy.HierarchyProxyManager`
Description	This session provides methods to manage a hierarchy. Each node is expressed as an OSID `Id` that represents an external object. The hierarchy only expresses relationships among these Ids. However, changing the hierarchy may have implications, such as inherited data, in the associated OSID.
Method	getHierarchyId
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	getHierarchy
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	canModifyHierarchy
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	addRoot
Description	Adds a root node.
Parameters	`osid.id.Id`	`id`	the `Id` of the node
Errors	ALREADY_EXISTS		`id` is already in hierarchy
	NOT_FOUND		`id` not found
	NULL_ARGUMENT		`id` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	addChild
Description	Adds a child to a `Id`.
Parameters	`osid.id.Id`	`id`	the `Id` of the node
Parameters	`osid.id.Id`	`childId`	the `Id` of the new child
Errors	ALREADY_EXISTS		`childId` is already a child of `id`
	NOT_FOUND		`id` or `childId` not found
	NULL_ARGUMENT		`id` or `childId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	removeRoot
Description	Removes a root node.
Parameters	`osid.id.Id`	`id`	the `Id` of the node
Errors	NOT_FOUND		`id` was not found or not in hierarchy
	NULL_ARGUMENT		`id` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	removeChild
Description	Removes a child from an `Id`.
Parameters	`osid.id.Id`	`id`	the `Id` of the node
Parameters	`osid.id.Id`	`childId`	the `Id` of the child to remove
Errors	NOT_FOUND		`id` or `childId` was not found or `childId` is not a child of `id`
	NULL_ARGUMENT		`id` or `childId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	removeChildren
Description	Removes all children from an `Id`.
Parameters	`osid.id.Id`	`id`	the `Id` of the node
Errors	NOT_FOUND		a node identified by the given `Id` was not found
	NULL_ARGUMENT		`id` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.