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

This session provides methods for managing a workflow.

MethodgetOfficeId
Description

Gets the Office Id associated with this session.

Returnosid.id.Idthe Office Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetOffice
Description

Gets the Office associated with this session.

Returnosid.workflow.Officethe office
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageWorkflow
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 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 management methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanManageWorkflowForProcess
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 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 management methods are not authorized, true otherwise
ErrorsNULL_ARGUMENT processId is null
CompliancemandatoryThis method must be implemented.
MethodsuspendWork
Description

Suspends a work in this process leaving it at its current step.

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

Resumes a work in this process.

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

Cancels a work in this process removing it from the workflow.

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