OSID Logo
OSID Specifications
workflow package
Version 3.0.0
Release Candidate Preview
Interfaceosid.workflow.Process
Implementsosid.OsidGovernator
Description

A Process.

MethodisEnabled
Description

Tests if this process is enabled.

Returnboolean true if this process is enabled, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetInitialStepId
Description

Gets the Id of the initial step of this process. All work goes through an initial step.

Returnosid.id.Idthe step Id
CompliancemandatoryThis method must be implemented.
MethodgetInitialStep
Description

Gets the initial step of this process.

Returnosid.workflow.Stepthe step
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetInitialStateId
Description

Gets the Id of the initial state of the work upon entering this process. The initial state is used to assign the work to an initial step that has this state as an initial state.

Returnosid.id.Idthe state Id
CompliancemandatoryThis method must be implemented.
MethodgetInitialState
Description

Gets the initial state of the work upon entering this process. The initial state is used to assign the work to an initial step that has this state as an initial state.

Returnosid.process.Statethe state
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetProcessRecord
Description

Gets the process record corresponding to the given Process record Type. This method is used to retrieve an object implementing the requested record. The processRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(processRecordType) is true .

Parametersosid.type.TypeprocessRecordTypethe type of process record to retrieve
Returnosid.workflow.records.ProcessRecordthe process record
ErrorsNULL_ARGUMENT processRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(processRecordType) is false
CompliancemandatoryThis method must be implemented.