OSID Logo
OSID Specifications
workflow package
Version 3.0.0
Release Candidate Preview
Interfaceosid.workflow.Step
Implementsosid.OsidGovernator
osid.Subjugateable
Description

A Step is an element in a Process in which Work is processed. The workers in this Step are represented by Resources or Resource groups. The input States list the states of Work that are valid to be accepted into this Step. Successful processing of the Work result in a single next State that determines the valid next Steps in the Process.

MethodgetProcessId
Description

Gets the Id of the process.

Returnosid.id.Idthe process Id
CompliancemandatoryThis method must be implemented.
MethodgetProcess
Description

Gets the process.

Returnosid.workflow.Processthe process
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetResourceIds
Description

Gets the Ids of the resources working in this step.

Returnosid.id.IdListthe resource Ids
CompliancemandatoryThis method must be implemented.
MethodgetResources
Description

Gets the resources working in this step.

Returnosid.resource.ResourceListthe resources
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetInputStateIds
Description

Gets the Ids of the valid states entering this step.

Returnosid.id.IdListthe state Ids
CompliancemandatoryThis method must be implemented.
MethodgetInputStates
Description

Gets the valid states to enter this step.

Returnosid.process.StateListthe states
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextStateId
Description

Gets the Id of the state of the work upon completing this step.

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

Gets the state of the work upon completing this step.

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

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

Parametersosid.type.TypestepRecordTypethe type of step record to retrieve
Returnosid.workflow.records.StepRecordthe step record
ErrorsNULL_ARGUMENT stepRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(stepRecordType) is false
CompliancemandatoryThis method must be implemented.