OSID - osid.mapping.LocationHierarchyDesignSession Service Interface Definition

Interface	osid.mapping.LocationHierarchyDesignSession
Implements	`osid.OsidSession`
Used By	`osid.mapping.MappingManager`
Used By	`osid.mapping.MappingProxyManager`
Description	This session defines methods for managing a hierarchy of `Locations`. Each node in the hierarchy is a unique `Location`.
Method	getLocationHierarchyId
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	getLocationHierarchy
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	canModifyLocationHierarchy
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	addRootLocation
Description	Adds a root location.
Parameters	`osid.id.Id`	`locationId`	the `Id` of a location
Errors	ALREADY_EXISTS		`locationId` is already in hierarchy
	NOT_FOUND		`locationId` not found
	NULL_ARGUMENT		`locationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	addChildLocation
Description	Adds a child to a location.
Parameters	`osid.id.Id`	`locationId`	the `Id` of a location
Parameters	`osid.id.Id`	`childId`	the `Id` of the new child
Errors	ALREADY_EXISTS		`mapId` is already a parent of `childId`
	NOT_FOUND		`locationId` not found
	NULL_ARGUMENT		`locationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.