OSID Logo
OSID Specifications
workflow package
Version 3.0.0
Release Candidate Preview
Interfaceosid.workflow.StepForm
Implementsosid.OsidGovernatorForm
osid.OsidSubjugateableForm
Description

This is the form for creating and updating Steps. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the StepAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

MethodgetInputStatesMetadata
Description

Gets the metadata for the input states.

Returnosid.Metadatametadata for the states
CompliancemandatoryThis method must be implemented.
MethodseInputStates
Description

Sets the input states.

Parametersosid.id.IdListstateIdsthe new input states
ErrorsINVALID_ARGUMENT stateId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT stateId is null
CompliancemandatoryThis method must be implemented.
MethodclearInputStates
Description

Removes the input states.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetNextStateMetadata
Description

Gets the metadata for the next state.

Returnosid.Metadatametadata for the state
CompliancemandatoryThis method must be implemented.
MethodsetNextState
Description

Sets the next state.

Parametersosid.id.IdstateIdthe new next state
ErrorsINVALID_ARGUMENT stateId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT stateId is null
CompliancemandatoryThis method must be implemented.
MethodclearNextState
Description

Removes the next state.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetStepFormRecord
Description

Gets the StepFormRecord corresponding to the given step record Type.

Parametersosid.type.TypestepRecordTypea step record type
Returnosid.workflow.records.StepFormRecordthe step form record
ErrorsNULL_ARGUMENT stepRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(stepRecordType) is false
CompliancemandatoryThis method must be implemented.