Interface | osid.workflow.ManualWorkflowSession | ||
---|---|---|---|
Implements | osid.workflow.WorkflowManagementSession | ||
Description |
This session provides methods for manually moving work through a workflow. | ||
Method | canOperateWorkflow | ||
Description |
Tests if this user can operate 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 operation methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canOperateWorkflowForProcess | ||
Description |
Tests if this user can operate 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 | ||
Parameters | osid.id.Id | processId | a process Id |
Return | boolean | false if workflow operation methods are not authorized,
true otherwise | |
Errors | NULL_ARGUMENT | processId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | advanceWork | ||
Description |
Advances work to a next step in the workflow based on the work and the input conditions of the next steps. | ||
Parameters | osid.id.Id | processId | a process Id |
osid.id.Id | workId | a work Id | |
Errors | NOT_FOUND | processId is not found or workId is in
process | |
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 | getValidNextStepsForWork | ||
Description |
Gets the valid next steps in this process in which the given work can be manually advanced. | ||
Parameters | osid.id.Id | processId | a process Id |
osid.id.Id | workId | a work Id | |
Return | osid.workflow.StepList | the returned Step list | |
Errors | NOT_FOUND | processId is not found or workId is in
process | |
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 | getAllValidStepsForWork | ||
Description |
Gets the all valid steps in this process the given work can be manually assigned and includes the steps previous to the work's current step. | ||
Parameters | osid.id.Id | processId | a process Id |
osid.id.Id | workId | a work Id | |
Return | osid.workflow.StepList | the returned Step list | |
Errors | NOT_FOUND | processId is not found or workId is in
process | |
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 | assignWorkToStep | ||
Description |
Manually assigns a work to a step. | ||
Parameters | osid.id.Id | processId | a process Id |
osid.id.Id | workId | a work Id | |
osid.id.Id | stepId | a step Id | |
Errors | NOT_FOUND | processId is not found or workId or
stepId is not found in this process | |
NULL_ARGUMENT | processId, workId, or stepId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |