OSID Logo
OSID Specifications
workflow package
Version 3.1.0
Interfaceosid.workflow.WorkflowInitiationSession
Implementsosid.OsidSession
Used Byosid.workflow.WorkflowManager
osid.workflow.WorkflowProxyManager
Description

This session provides methods for initiating a workflow.

MethodgetOfficeId
Description

Gets the Office Id associated with this session.

Returnosid.id.Id the Office Id associated with this session
Compliancemandatory This method must be implemented.
MethodgetOffice
Description

Gets the Office associated with this session.

Returnosid.workflow.Office the office
ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodcanInitiateWorkflow
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 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 initiation methods are not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethodcanInitiateWorkflowForProcess
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 PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer workflow operations to unauthorized users.

Parametersosid.id.IdprocessId a process Id
Returnboolean false if workflow initiation methods are not authorized, true otherwise
ErrorsNULL_ARGUMENT processId is null
Compliancemandatory This method must be implemented.
MethodgetAvailableWork
Description

Gets the list of available work for this workflow. Available work is Work that is compatible with this Process but not currently part of this Process.

Parametersosid.id.IdprocessId a process Id
Returnosid.workflow.WorkList the returned Work list
ErrorsNOT_FOUND processId is not found
NULL_ARGUMENT processId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodstartWorkflow
Description

Starts a work in the workflow at the initial step of the process.

Parametersosid.id.IdprocessId a process Id
osid.id.IdworkId a work Id
ErrorsNOT_FOUND processId or workId is not found
NULL_ARGUMENT processId or workId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.