OSID - osid.logging.LogHierarchyDesignSession Service Interface Definition

Interface	osid.logging.LogHierarchyDesignSession
Implements	`osid.OsidSession`
Used By	`osid.logging.LoggingManager`
Used By	`osid.logging.LoggingProxyManager`
Description	This session manages a hierarchy of logs. Logs may be organized into a hierarchy for organizing or federating. A parent `Log` includes all of the Ids of its children such that a single root node contains all of the `Ids` of the federation.
Method	getLogHierarchyId
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	getLogHierarchy
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	canModifyLogHierarchy
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	addRootLog
Description	Adds a root log.
Parameters	`osid.id.Id`	`logId`	the `Id` of a log
Errors	ALREADY_EXISTS		`logId` is already in hierarchy
	NOT_FOUND		`logId` is not found
	NULL_ARGUMENT		`logId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	removeRootLog
Description	Removes a root log.
Parameters	`osid.id.Id`	`logId`	the `Id` of a log
Errors	NOT_FOUND		`logId` is not a root
	NULL_ARGUMENT		`logId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	addChildLog
Description	Adds a child to a log.
Parameters	`osid.id.Id`	`logId`	the `Id` of a log
Parameters	`osid.id.Id`	`childId`	the `Id` of the new child
Errors	ALREADY_EXISTS		`logId` is already a parent of `childId`
	NOT_FOUND		`logId` or `childId` not found
	NULL_ARGUMENT		`logId` or `childId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	removeChildLog
Description	Removes a child from a log.
Parameters	`osid.id.Id`	`logId`	the `Id` of a log
Parameters	`osid.id.Id`	`childId`	the `Id` of the new child
Errors	NOT_FOUND		`logId` not a parent of `childId`
	NULL_ARGUMENT		`logId` or `childId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	removeChildLogs
Description	Removes all children from a log.
Parameters	`osid.id.Id`	`logId`	the `Id` of a log
Errors	NOT_FOUND		`logId` not in hierarchy
	NULL_ARGUMENT		`logId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.