OSID Logo
OSID Specifications
workflow package
Version 3.1.0
Interfaceosid.workflow.Step
Implementsosid.OsidRule
osid.Subjugateable
Used Byosid.workflow.Process
osid.workflow.StepAdminSession
osid.workflow.StepList
osid.workflow.StepLookupSession
osid.workflow.WorkflowSession
osid.workflow.event.WorkflowEvent
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.Id the process Id
Compliancemandatory This method must be implemented.
MethodgetProcess
Description

Gets the process.

Returnosid.workflow.Process the process
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetResourceIds
Description

Gets the Ids of the resources working in this step.

Returnosid.id.IdList the resource Ids
Compliancemandatory This method must be implemented.
MethodgetResources
Description

Gets the resources working in this step.

Returnosid.resource.ResourceList the resources
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetInputStateIds
Description

Gets the Ids of the valid states entering this step.

Returnosid.id.IdList the state Ids
Compliancemandatory This method must be implemented.
MethodgetInputStates
Description

Gets the valid states to enter this step.

Returnosid.process.StateList the states
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetNextStateId
Description

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

Returnosid.id.Id the state Id
Compliancemandatory This method must be implemented.
MethodgetNextState
Description

Gets the state of the work upon completing this step.

Returnosid.process.State the state
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This 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.TypestepRecordType the type of step record to retrieve
Returnosid.workflow.records.StepRecord the step record
ErrorsNULL_ARGUMENT stepRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(stepRecordType) is false
Compliancemandatory This method must be implemented.