OSID Specifications
process package
Version 3.1.0
process package
Version 3.1.0
| Interface | osid.process.ProcessHierarchyDesignSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Used By | osid.process.ProcessManager | ||
osid.process.ProcessProxyManager | |||
| Description |
This session defines methods for managing a hierarchy of
| ||
| Method | getProcessHierarchyId | ||
| Description |
Gets the hierarchy | ||
| 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 | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canModifyProcessHierarchy | ||
| 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 | ||
| Return | boolean | false if changing this hierarchy is not authorized,
true otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | addRootProcess | ||
| Description |
Adds a root process. | ||
| Parameters | osid.id.Id | processId | the Id of a process |
| Errors | ALREADY_EXISTS | processId is already in hierarchy | |
| 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 | removeRootProcess | ||
| Description |
Removes a root process. | ||
| Parameters | osid.id.Id | processId | the Id of a process |
| Errors | NOT_FOUND | processId is not a root | |
| NULL_ARGUMENT | processId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | addChildProcess | ||
| Description |
Adds a child to a process. | ||
| Parameters | osid.id.Id | processId | the Id of a process |
osid.id.Id | childId | the Id of the new child | |
| Errors | ALREADY_EXISTS | processId is already a parent of childId | |
| NOT_FOUND | processId or childId not found | ||
| NULL_ARGUMENT | processId or childId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeChildProcess | ||
| Description |
Removes a child from a process. | ||
| Parameters | osid.id.Id | processId | the Id of a process |
osid.id.Id | childId | the Id of the new child | |
| Errors | NOT_FOUND | processId not a parent of childId | |
| NULL_ARGUMENT | processId or childId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeChildProcesses | ||
| Description |
Removes all children from a process. | ||
| Parameters | osid.id.Id | processId | the Id of a process |
| Errors | NOT_FOUND | processId not in hierarchy | |
| NULL_ARGUMENT | processId or childId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |