Interface | osid.workflow.WorkflowInitiationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for initiating 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 | canInitiateWorkflow | ||
Description |
Tests if this user can initiate 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 initiation methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canInitiateWorkflowForProcess | ||
Description |
Tests if this user can initiate a workflow in 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 initiation methods are not authorized,
true otherwise | |
Errors | NULL_ARGUMENT | processId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAvailableWork | ||
Description |
Gets the list of available work for this workflow.
Available work is | ||
Parameters | osid.id.Id | processId | a process Id |
Return | osid.workflow.WorkList | the returned Work list | |
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 | startWorkflow | ||
Description |
Starts a work in the workflow at the initial step of the 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. |