| Interface | osid.workflow.WorkflowManagementSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides methods for managing a workflow. | ||
| Method | getOfficeId | ||
| Description |
Gets the | ||
| Return | osid.id.Id | the Office Id associated with this session | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getOffice | ||
| Description |
Gets the | ||
| Return | osid.workflow.Office | the office | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canManageWorkflow | ||
| Description |
Tests if this user can manage a workflow. 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 | ||
| Return | boolean | false if workflow management methods are not authorized,
true otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | canManageWorkflowForProcess | ||
| Description |
Tests if this user can manage a workflow for a process.
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 | ||
| Parameters | osid.id.Id | processId | a process Id |
| Return | boolean | false if workflow management methods are not authorized,
true otherwise | |
| Errors | NULL_ARGUMENT | processId is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | suspendWork | ||
| Description |
Suspends a work in this process leaving it at its current step. | ||
| Parameters | osid.id.Id | processId | a process Id |
osid.id.Id | workId | a work Id | |
| Errors | NOT_FOUND | processId or workId is not found | |
| NULL_ARGUMENT | processId or workId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | resumeWork | ||
| Description |
Resumes a work in this process. | ||
| Parameters | osid.id.Id | processId | a process Id |
osid.id.Id | workId | a work Id | |
| Errors | NOT_FOUND | processId or workId is not found | |
| NULL_ARGUMENT | processId or workId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | cancelWork | ||
| Description |
Cancels a work in this process removing it from the workflow. | ||
| Parameters | osid.id.Id | processId | a process Id |
osid.id.Id | workId | a work Id | |
| Errors | NOT_FOUND | processId or workId is not found | |
| NULL_ARGUMENT | processId or workId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |