OSID - osid.offering.CatalogueHierarchyDesignSession Service Interface Definition

Interface	osid.offering.CatalogueHierarchyDesignSession
Implements	`osid.OsidSession`
Used By	`osid.offering.OfferingManager`
Used By	`osid.offering.OfferingProxyManager`
Description	This session manages a hierarchy of catalogues. Catalogues may be organized into a hierarchy for organizing or federating. A parent `Catalogue` includes all of the canonical units of its children such that a single root node contains all of the canonical units of the federation.
Method	getCatalogueHierarchyId
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	getCatalogueHierarchy
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	canModifyCatalogueHierarchy
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	addRootCatalogue
Description	Adds a root catalogue.
Parameters	`osid.id.Id`	`catalogueId`	the `Id` of a catalogue
Errors	ALREADY_EXISTS		`catalogueId` is already in hierarchy
	NOT_FOUND		`catalogueId` is not found
	NULL_ARGUMENT		`catalogueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	removeRootCatalogue
Description	Removes a root catalogue.
Parameters	`osid.id.Id`	`catalogueId`	the `Id` of a catalogue
Errors	NOT_FOUND		`catalogueId` is not found
	NULL_ARGUMENT		`catalogueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	addChildCatalogue
Description	Adds a child to a catalogue.
Parameters	`osid.id.Id`	`catalogueId`	the `Id` of a catalogue
Parameters	`osid.id.Id`	`childId`	the `Id` of the new child
Errors	ALREADY_EXISTS		`catalogueId` is already a parent of `childId`
	NOT_FOUND		`catalogueId` or `childId` not found
	NULL_ARGUMENT		`catalogueId` or `childId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	removeChildCatalogue
Description	Removes a child from a catalogue.
Parameters	`osid.id.Id`	`catalogueId`	the `Id` of a catalogue
Parameters	`osid.id.Id`	`childId`	the `Id` of the new child
Errors	NOT_FOUND		`catalogueId` not a parent of `childId`
	NULL_ARGUMENT		`catalogueId` or `childId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	removeChildCatalogues
Description	Removes all children from a catalogue.
Parameters	`osid.id.Id`	`catalogueId`	the `Id` of a catalogue
Errors	NOT_FOUND		`catalogueId` is not found
	NULL_ARGUMENT		`catalogueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.