OSID - osid.search.EngineHierarchyDesignSession Service Interface Definition

Interface	osid.search.EngineHierarchyDesignSession
Implements	`osid.OsidSession`
Used By	`osid.search.SearchManager`
Used By	`osid.search.SearchProxyManager`
Description	This session manages a hierarchy of engines. Engines may be organized into a hierarchy for organizing or federating. A parent `Engine` includes all of the search of its children such that a single root node contains all of the search of the federation.
Method	getEngineHierarchyId
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	getEngineHierarchy
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	canModifyEngineHierarchy
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	addRootEngine
Description	Adds a root engine.
Parameters	`osid.id.Id`	`engineId`	the `Id` of an engine
Errors	ALREADY_EXISTS		`engineId` is already in hierarchy
	NOT_FOUND		`engineId` not found
	NULL_ARGUMENT		`engineId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	removeRootEngine
Description	Removes a root engine.
Parameters	`osid.id.Id`	`engineId`	the `Id` of an engine
Errors	NOT_FOUND		`engineId` not a root
	NULL_ARGUMENT		`engineId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	addChildEngine
Description	Adds a child to an engine.
Parameters	`osid.id.Id`	`engineId`	the `Id` of an engine
Parameters	`osid.id.Id`	`childId`	the `Id` of the new child
Errors	ALREADY_EXISTS		`engineId` is already a parent of `childId`
	NOT_FOUND		`engineId` or `childId` not found
	NULL_ARGUMENT		`engineId` or `childId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	removeChildEngine
Description	Removes a child from an engine.
Parameters	`osid.id.Id`	`engineId`	the `Id` of an engine
Parameters	`osid.id.Id`	`childId`	the `Id` of the new child
Errors	NOT_FOUND		`engineId` not a parent of `childId`
	NULL_ARGUMENT		`engineId` or `childId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	removeChildEngines
Description	Removes all children from an engine.
Parameters	`osid.id.Id`	`engineId`	the `Id` of an engine
Errors	NOT_FOUND		`engineId` not in hierarchy
	NULL_ARGUMENT		`engineId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.