OSID Logo
OSID Specifications
workflow package
Version 3.0.0
Release Candidate Preview
Interfaceosid.workflow.ManualWorkflowSession
Implementsosid.workflow.WorkflowManagementSession
Description

This session provides methods for manually moving work through a workflow.

MethodcanOperateWorkflow
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 PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer workflow operations to unauthorized users.

Returnboolean false if workflow operation methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanOperateWorkflowForProcess
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 PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer workflow operations to unauthorized users.

Parametersosid.id.IdprocessIda process Id
Returnboolean false if workflow operation methods are not authorized, true otherwise
ErrorsNULL_ARGUMENT processId is null
CompliancemandatoryThis method must be implemented.
MethodadvanceWork
Description

Advances work to a next step in the workflow based on the work and the input conditions of the next steps.

Parametersosid.id.IdprocessIda process Id
osid.id.IdworkIda work Id
ErrorsNOT_FOUND processId is not found or workId is in process
NULL_ARGUMENT processId or workId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetValidNextStepsForWork
Description

Gets the valid next steps in this process in which the given work can be manually advanced.

Parametersosid.id.IdprocessIda process Id
osid.id.IdworkIda work Id
Returnosid.workflow.StepListthe returned Step list
ErrorsNOT_FOUND processId is not found or workId is in process
NULL_ARGUMENT processId or workId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAllValidStepsForWork
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.

Parametersosid.id.IdprocessIda process Id
osid.id.IdworkIda work Id
Returnosid.workflow.StepListthe returned Step list
ErrorsNOT_FOUND processId is not found or workId is in process
NULL_ARGUMENT processId or workId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodassignWorkToStep
Description

Manually assigns a work to a step.

Parametersosid.id.IdprocessIda process Id
osid.id.IdworkIda work Id
osid.id.IdstepIda step Id
ErrorsNOT_FOUND processId is not found or workId or stepId is not found in this process
NULL_ARGUMENT processId, workId, or stepId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.