OSID - osid.process.ProcessHierarchySession Service Interface Definition

Interface	osid.process.ProcessHierarchySession
Implements	`osid.OsidSession`
Description	This session defines methods for traversing a hierarchy of `Process` objects. Each node in the hierarchy is a unique `Process.` The hierarchy may be traversed recursively to establish the tree structure through `getParentProcesses()` and `getChildProcesses().` To relate these `Ids` to another OSID, `getProcessNodes()` can be used for retrievals that can be used for bulk lookups in other OSIDs. Any `Process` available in the Process 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 `getParentProcesses()` or `getChildProcesses()` 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: process elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition
Method	getProcessHierarchyId
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	getProcessHierarchy
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	canAccessProcessHierarchy
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 application that may opt not to offer lookup operations.
Return	`boolean`		`false` if hierarchy traversal methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeProcessView
Description	The returns from the process 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	usePlenaryProcessView
Description	A complete view of the `Process` 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	getRootProcessIds
Description	Gets the root process `Ids` in this hierarchy.
Return	`osid.id.IdList`		the root process `Ids`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRootProcesses
Description	Gets the root processes in the process hierarchy. A node with no parents is an orphan. While all process `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.process.ProcessList`		the root processes
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	hasParentProcesses
Description	Tests if the `Process` has any parents.
Parameters	`osid.id.Id`	`processId`	a process `Id`
Return	`boolean`		`true` if the process has parents, `false` otherwise
Errors	NOT_FOUND		`processId` is not found
	NULL_ARGUMENT		`processId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isParentOfProcess
Description	Tests if an `Id` is a direct parent of a process.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`processId`	a process `Id`
Return	`boolean`		`true` if this `id` is a parent of `processId,` `false` otherwise
Errors	NOT_FOUND		`processId` is not found
	NULL_ARGUMENT		`id` or `processId` 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	getParentProcessIds
Description	Gets the parent `Ids` of the given process.
Parameters	`osid.id.Id`	`processId`	a process `Id`
Return	`osid.id.IdList`		the parent `Ids` of the process
Errors	NOT_FOUND		`processId` is not found
	NULL_ARGUMENT		`processId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParentProcesses
Description	Gets the parents of the given process.
Parameters	`osid.id.Id`	`processId`	the `Id` to query
Return	`osid.process.ProcessList`		the parents of the process
Errors	NOT_FOUND		`processId` not found
	NULL_ARGUMENT		`processId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isAncestorOfProcess
Description	Tests if an `Id` is an ancestor of a process.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`processId`	the `Id` of a process
Return	`boolean`		`true` if this `id` is an ancestor of `processId,` `false` otherwise
Errors	NOT_FOUND		`processId` not found
	NULL_ARGUMENT		`processId` 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	hasChildProcesses
Description	Tests if a process has any children.
Parameters	`osid.id.Id`	`processId`	a `processId`
Return	`boolean`		`true` if the `processId` has children, `false` otherwise
Errors	NOT_FOUND		`processId` not found
	NULL_ARGUMENT		`processId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isChildOfProcess
Description	Tests if a process is a direct child of another.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`processId`	the `Id` of a process
Return	`boolean`		`true` if the `id` is a child of `processId,` `false` otherwise
Errors	NOT_FOUND		`processId` not found
	NULL_ARGUMENT		`processId` or `id` 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	getChildProcessIds
Description	Gets the child `Ids` of the given process.
Parameters	`osid.id.Id`	`processId`	the `Id` to query
Return	`osid.id.IdList`		the children of the process
Errors	NOT_FOUND		`processId` not found
	NULL_ARGUMENT		`processId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getChildProcesses
Description	Gets the children of the given process.
Parameters	`osid.id.Id`	`processId`	the `Id` to query
Return	`osid.process.ProcessList`		the children of the process
Errors	NOT_FOUND		`processId` not found
	NULL_ARGUMENT		`processId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isDescendantOfProcess
Description	Tests if an `Id` is a descendant of a process.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`processId`	the `Id` of a process
Return	`boolean`		`true` if the `id` is a descendant of the `processId,` `false` otherwise
Errors	NOT_FOUND		`processId` not found
	NULL_ARGUMENT		`processId` 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	getProcessNodeIds
Description	Gets a portion of the hierarchy for the given process.
Parameters	`osid.id.Id`	`processId`	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 process node
Errors	NOT_FOUND		`processId` not found
	NULL_ARGUMENT		`processId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProcessNodes
Description	Gets a portion of the hierarchy for the given process.
Parameters	`osid.id.Id`	`processId`	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.process.ProcessNode`		a process node
Errors	NOT_FOUND		`processId` not found
	NULL_ARGUMENT		`processId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.