OSID Logo
OSID Specifications
process package
Version 3.0.0
Release Candidate Preview
Interfaceosid.process.ProcessHierarchySession
Implementsosid.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
MethodgetProcessHierarchyId
Description

Gets the hierarchy Id associated with this session.

Returnosid.id.Idthe hierarchy Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetProcessHierarchy
Description

Gets the hierarchy associated with this session.

Returnosid.hierarchy.Hierarchythe hierarchy associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanAccessProcessHierarchy
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.

Returnboolean false if hierarchy traversal methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeProcessView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryProcessView
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.

CompliancemandatoryThis method is must be implemented.
MethodgetRootProcessIds
Description

Gets the root process Ids in this hierarchy.

Returnosid.id.IdListthe root process Ids
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRootProcesses
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.

Returnosid.process.ProcessListthe root processes
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodhasParentProcesses
Description

Tests if the Process has any parents.

Parametersosid.id.IdprocessIda process Id
Returnboolean true if the process has parents, false otherwise
ErrorsNOT_FOUND processId is not found
NULL_ARGUMENT processId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisParentOfProcess
Description

Tests if an Id is a direct parent of a process.

Parametersosid.id.Ididan Id
osid.id.IdprocessIda process Id
Returnboolean true if this id is a parent of processId, false otherwise
ErrorsNOT_FOUND processId is not found
NULL_ARGUMENT id or processId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id not found return false.

MethodgetParentProcessIds
Description

Gets the parent Ids of the given process.

Parametersosid.id.IdprocessIda process Id
Returnosid.id.IdListthe parent Ids of the process
ErrorsNOT_FOUND processId is not found
NULL_ARGUMENT processId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetParentProcesses
Description

Gets the parents of the given process.

Parametersosid.id.IdprocessIdthe Id to query
Returnosid.process.ProcessListthe parents of the process
ErrorsNOT_FOUND processId not found
NULL_ARGUMENT processId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisAncestorOfProcess
Description

Tests if an Id is an ancestor of a process.

Parametersosid.id.Ididan Id
osid.id.IdprocessIdthe Id of a process
Returnboolean true if this id is an ancestor of processId, false otherwise
ErrorsNOT_FOUND processId not found
NULL_ARGUMENT processId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id not found return false.

MethodhasChildProcesses
Description

Tests if a process has any children.

Parametersosid.id.IdprocessIda processId
Returnboolean true if the processId has children, false otherwise
ErrorsNOT_FOUND processId not found
NULL_ARGUMENT processId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisChildOfProcess
Description

Tests if a process is a direct child of another.

Parametersosid.id.Ididan Id
osid.id.IdprocessIdthe Id of a process
Returnboolean true if the id is a child of processId, false otherwise
ErrorsNOT_FOUND processId not found
NULL_ARGUMENT processId or id is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id not found return false.

MethodgetChildProcessIds
Description

Gets the child Ids of the given process.

Parametersosid.id.IdprocessIdthe Id to query
Returnosid.id.IdListthe children of the process
ErrorsNOT_FOUND processId not found
NULL_ARGUMENT processId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetChildProcesses
Description

Gets the children of the given process.

Parametersosid.id.IdprocessIdthe Id to query
Returnosid.process.ProcessListthe children of the process
ErrorsNOT_FOUND processId not found
NULL_ARGUMENT processId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisDescendantOfProcess
Description

Tests if an Id is a descendant of a process.

Parametersosid.id.Ididan Id
osid.id.IdprocessIdthe Id of a process
Returnboolean true if the id is a descendant of the processId, false otherwise
ErrorsNOT_FOUND processId not found
NULL_ARGUMENT processId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id is not found return false.

MethodgetProcessNodeIds
Description

Gets a portion of the hierarchy for the given process.

Parametersosid.id.IdprocessIdthe Id to query
cardinalancestorLevelsthe maximum number of ancestor levels to include. A value of 0 returns no parents in the node.
cardinaldescendantLevelsthe maximum number of descendant levels to include. A value of 0 returns no children in the node.
booleanincludeSiblings true to include the siblings of the given node, false to omit the siblings
Returnosid.hierarchy.Nodea process node
ErrorsNOT_FOUND processId not found
NULL_ARGUMENT processId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProcessNodes
Description

Gets a portion of the hierarchy for the given process.

Parametersosid.id.IdprocessIdthe Id to query
cardinalancestorLevelsthe maximum number of ancestor levels to include. A value of 0 returns no parents in the node.
cardinaldescendantLevelsthe maximum number of descendant levels to include. A value of 0 returns no children in the node.
booleanincludeSiblings true to include the siblings of the given node, false to omit the siblings
Returnosid.process.ProcessNodea process node
ErrorsNOT_FOUND processId not found
NULL_ARGUMENT processId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.