OSID - osid.subscription.PublisherHierarchyDesignSession Service Interface Definition

Interface	osid.subscription.PublisherHierarchyDesignSession
Implements	`osid.OsidSession`
Used By	`osid.subscription.SubscriptionManager`
Used By	`osid.subscription.SubscriptionProxyManager`
Description	This session manages a hierarchy of publishers. Publishers may be organized into a hierarchy for organizing or federating. A parent `Publisher` includes all of the subscriptions of its children such that a single root node contains all of the subscriptions of the federation.
Method	getPublisherHierarchyId
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	getPublisherHierarchy
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	canModifyPublisherHierarchy
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	addRootPublisher
Description	Adds a root publisher.
Parameters	`osid.id.Id`	`publisherId`	the `Id` of a publisher
Errors	ALREADY_EXISTS		`publisherId` is already in hierarchy
	NOT_FOUND		`publisherId` is not found
	NULL_ARGUMENT		`publisherId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	removeRootPublisher
Description	Removes a root publisher.
Parameters	`osid.id.Id`	`publisherId`	the `Id` of a publisher
Errors	NOT_FOUND		`publisherId` is not a root
	NULL_ARGUMENT		`publisherId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	addChildPublisher
Description	Adds a child to a publisher.
Parameters	`osid.id.Id`	`publisherId`	the `Id` of a publisher
Parameters	`osid.id.Id`	`childId`	the `Id` of the new child
Errors	ALREADY_EXISTS		`publisherId` is already a parent of `childId`
	NOT_FOUND		`publisherId` or `childId` not found
	NULL_ARGUMENT		`publisherId` or `childId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	removeChildPublisher
Description	Removes a child from a publisher.
Parameters	`osid.id.Id`	`publisherId`	the `Id` of a publisher
Parameters	`osid.id.Id`	`childId`	the `Id` of the new child
Errors	NOT_FOUND		`publisherId` not a parent of `childId`
	NULL_ARGUMENT		`publisherId` or `childId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	removeChildPublishers
Description	Removes all children from a publisher.
Parameters	`osid.id.Id`	`publisherId`	the `Id` of a publisher
Errors	NOT_FOUND		`publisherId` not found
	NULL_ARGUMENT		`publisherId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.