OSID - osid.logging.LogHierarchySession Service Interface Definition

Interface	osid.logging.LogHierarchySession
Implements	`osid.OsidSession`
Description	This session defines methods for traversing a hierarchy of `Log` objects. Each node in the hierarchy is a unique `Log.` The hierarchy may be traversed recursively to establish the tree structure through `getParentLogs()` and `getChildLogs().` To relate these `Ids` to another OSID, `getLogNodes()` can be used for retrievals that can be used for bulk lookups in other OSIDs. Any `Log` available in the Log OSID is known to this hierarchy but does not appear in the hierarchy traversal until added as a root node or a child of another node. A user may not be authorized to traverse the entire hierarchy. Parts of the hierarchy may be made invisible through omission from the returns of `getParentLogs()` or `getChildLogs()` in lieu of a `PERMISSION_DENIED` error that may disrupt the traversal through authorized pathways. This session defines views that offer differing behaviors when retrieving multiple objects. comparative view: log elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition
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	canAccessLogHierarchy
Description	Tests if this user can perform hierarchy queries. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED.` This is intended as a hint to an an application that may not offer hierrachy traversal operations to unauthorized users.
Return	`boolean`		`false` if hierarchy traversal methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeLogView
Description	The returns from the log methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryLogView
Description	A complete view of the `Log` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	getRootLogIds
Description	Gets the root log `Ids` in this hierarchy.
Return	`osid.id.IdList`		the root log `Ids`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRootLogs
Description	Gets the root logs in the log hierarchy. A node with no parents is an orphan. While all log `Ids` are known to the hierarchy, an orphan does not appear in the hierarchy unless explicitly added as a root node or child of another node.
Return	`osid.logging.LogList`		the root logs
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	hasParentLogs
Description	Tests if the `Log` has any parents.
Parameters	`osid.id.Id`	`logId`	the `Id` of a log
Return	`boolean`		`true` if the log has parents, `false` otherwise
Errors	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	isParentOfLog
Description	Tests if an `Id` is a direct parent of a log.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`logId`	the `Id` of a log
Return	`boolean`		`true` if this `id` is a parent of `logId,` `false` otherwise
Errors	NOT_FOUND		`logId` is not found
	NULL_ARGUMENT		`id` or `logId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If `id` not found return `false.`
Method	getParentLogIds
Description	Gets the parent `Ids` of the given log.
Parameters	`osid.id.Id`	`logId`	the `Id` of a log
Return	`osid.id.IdList`		the parent `Ids` of the log
Errors	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	getParentLogs
Description	Gets the parent logs of the given `id.`
Parameters	`osid.id.Id`	`logId`	the `Id` of the `Log` to query
Return	`osid.logging.LogList`		the parent logs of the `id`
Errors	NOT_FOUND		a `Log` identified by `Id 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	isAncestorOfLog
Description	Tests if an `Id` is an ancestor of a log.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`logId`	the `Id` of a log
Return	`boolean`		`true` if the `id` is an ancestor of the `logId,` `false` otherwise
Errors	NOT_FOUND		`logId` is not found
	NULL_ARGUMENT		`id` or `logId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If `id` is not found return `false.`
Method	hasChildLogs
Description	Tests if a log has any children.
Parameters	`osid.id.Id`	`logId`	the `Id` of a log
Return	`boolean`		`true` if the `logId` has children, `false` otherwise
Errors	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	isChildOfLog
Description	Tests if an `Id` is a direct child of a log.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`logId`	the `Id` of a log
Return	`boolean`		`true` if this `id` is a child of `logId,` `false` otherwise
Errors	NOT_FOUND		`logId` is not found
	NULL_ARGUMENT		`id` or `logId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If `id` not found return `false.`
Method	getChildLogIds
Description	Gets the child `Ids` of the given log.
Parameters	`osid.id.Id`	`logId`	the `Id` to query
Return	`osid.id.IdList`		the children of the depot
Errors	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	getChildLogs
Description	Gets the child logs of the given `id.`
Parameters	`osid.id.Id`	`logId`	the `Id` of the `Log` to query
Return	`osid.logging.LogList`		the child logs of the `id`
Errors	NOT_FOUND		a `Log` identified by `Id 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	isDescendantOfLog
Description	Tests if an `Id` is a descendant of a log.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`logId`	the `Id` of a log
Return	`boolean`		`true` if the `id` is a descendant of the `logId,` `false` otherwise
Errors	NOT_FOUND		`logId` is not found
	NULL_ARGUMENT		`id` or `logId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If `id` is not found return `false.`
Method	getLogNodeIds
Description	Gets a portion of the hierarchy for the given log.
Parameters	`osid.id.Id`	`logId`	the `Id` to query
	`cardinal`	`ancestorLevels`	the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.
	`cardinal`	`descendantLevels`	the maximum number of descendant levels to include. A value of 0 returns no children in the node.
	`boolean`	`includeSiblings`	`true` to include the siblings of the given node, `false` to omit the siblings
Return	`osid.hierarchy.Node`		a log node
Errors	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	getLogNodes
Description	Gets a portion of the hierarchy for the given log.
Parameters	`osid.id.Id`	`logId`	the `Id` to query
	`cardinal`	`ancestorLevels`	the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.
	`cardinal`	`descendantLevels`	the maximum number of descendant levels to include. A value of 0 returns no children in the node.
	`boolean`	`includeSiblings`	`true` to include the siblings of the given node, `false` to omit the siblings
Return	`osid.logging.LogNode`		a log node
Errors	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.