OSID - osid.transport.EndpointHierarchyDesignSession Service Interface Definition

Interface	osid.transport.EndpointHierarchyDesignSession
Implements	`osid.OsidSession`
Used By	`osid.transport.TransportManager`
Used By	`osid.transport.TransportProxyManager`
Description	This session defines methods for managing a hierarchy of `Endpoint` objects. Each node in the hierarchy is a unique `Endpoint`.
Method	getEndpointHierarchyId
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	getEndpointHierarchy
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	canModifyEndpointHierarchy
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	addRootEndpoint
Description	Adds a root endpoint.
Parameters	`osid.id.Id`	`endpointId`	the `Id` of a endpoint
Errors	ALREADY_EXISTS		`endpointId` is already in hierarchy
	NOT_FOUND		`endpointId` not found
	NULL_ARGUMENT		`endpointId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	removeRootEndpoint
Description	Removes a root endpoint.
Parameters	`osid.id.Id`	`endpointId`	the `Id` of a endpoint
Errors	NOT_FOUND		`endpointId` not a root
	NULL_ARGUMENT		`endpointId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	addChildEndpoint
Description	Adds a child to a endpoint.
Parameters	`osid.id.Id`	`endpointId`	the `Id` of a endpoint
Parameters	`osid.id.Id`	`childId`	the `Id` of the new child
Errors	ALREADY_EXISTS		`endpointId` is already a parent of `childId`
	NOT_FOUND		`endpointId` or `childId` not found
	NULL_ARGUMENT		`endpointId` or `childId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	removeChildEndpoint
Description	Removes a child from a endpoint.
Parameters	`osid.id.Id`	`endpointId`	the `Id` of a endpoint
Parameters	`osid.id.Id`	`childId`	the `Id` of the new child
Errors	NOT_FOUND		`endpointId` not a parent of `childId`
	NULL_ARGUMENT		`endpointId` or `childId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	removeChildEndpoints
Description	Removes all children from a endpoint.
Parameters	`osid.id.Id`	`endpointId`	the `Id` of a endpoint
Errors	NOT_FOUND		`endpointId` not in hierarchy
	NULL_ARGUMENT		`endpointId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.