OSID Logo
OSID Specifications
workflow package
Version 3.0.0
Release Candidate Preview
Interfaceosid.workflow.ProcessForm
Implementsosid.OsidGovernatorForm
Description

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

MethodgetEnabledMetadata
Description

Gets the metadata for the enabled flag.

Returnosid.Metadatametadata for the enabled flag
CompliancemandatoryThis method must be implemented.
MethodsetEnabled
Description

Sets the enabled flag.

Parametersbooleanenabledthe new enabled flag
ErrorsINVALID_ARGUMENT enabled is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearEnabled
Description

Removes the enabled flag.

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

Gets the metadata for the initial step.

Returnosid.Metadatametadata for the initial step
CompliancemandatoryThis method must be implemented.
MethodsetInitialStep
Description

Sets the initial step.

Parametersosid.id.IdstepIdthe new initial step
ErrorsINVALID_ARGUMENT stepId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT stepId is null
CompliancemandatoryThis method must be implemented.
MethodclearInitialStep
Description

Removes the initial step.

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

Gets the metadata for the initial state.

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

Sets the initial state.

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

Removes the initial state.

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

Gets the ProcessFormRecord corresponding to the given process record Type.

Parametersosid.type.TypeprocessRecordTypea process record type
Returnosid.workflow.records.ProcessFormRecordthe process form record
ErrorsNULL_ARGUMENT processRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(processRecordType) is false
CompliancemandatoryThis method must be implemented.