Assembly: OptimaJet.Workflow.Core

Interface IDesignerParameterFormatProvider

OptimaJet.Workflow.Core.Runtime.IDesignerParameterFormatProvider

Supplies the Workflow Designer with metadata used to build structured editors for the parameters of named workflow actions, conditions, and rules.

Namespace: OptimaJet.Workflow.Core.Runtime

public interface IDesignerParameterFormatProvider

Type Hierarchy

Methods

List<CodeActionParameterDefinition> GetFormat(CodeActionType type, string name, string schemeCode) #
Gets the ordered form-field definitions for a named action, condition, or rule.

Parameters

Name
Type
Description
type
CodeActionType
The parameter usage context: CodeActionType.Action, CodeActionType.Condition, CodeActionType.RuleCheck, or CodeActionType.RuleGet.
name
String
The action, condition, or rule name selected in the Designer.
schemeCode
String
The current process scheme code, which can be used to provide scheme-specific fields. The value may be null when the format is requested without a process scheme context.

Returns

Type
Description
List<CodeActionParameterDefinition>
An ordered list containing one CodeActionParameterDefinition per form field. Returning null or an empty list indicates that no structured parameter editor is defined; the Designer then uses its raw JSON editor.

Remarks

When a user edits an action parameter on an activity, a condition parameter on a transition, or a rule parameter on an actor, the Designer requests definitions for the selected provider method and the current process scheme. Each CodeActionParameterDefinition describes one form field, including its name, label, control type, required state, default value, available choices, and explanatory text.

The Designer serializes the values entered in the generated form into the parameter string stored in the process scheme. At runtime, that string is passed to the corresponding IWorkflowActionProvider or IWorkflowRuleProvider method. This provider supplies design-time UI metadata only; it does not parse the resulting value or execute the action, condition, or rule.

A non-empty CodeActionDefinition.ParameterDefinitions collection declared directly on a matching scheme code action takes precedence over this provider. If neither the code action nor this provider supplies definitions, the Designer uses its raw JSON parameter editor instead of a generated form.