Assembly: OptimaJet.Workflow.Core

Class ParameterDefinitionReference

OptimaJet.Workflow.Core.Model.ParameterDefinitionReference

Represents a command input parameter in CommandDefinition.InputParameters and maps its value to a scheme-level ParameterDefinition.

public class ParameterDefinitionReference

Properties

public string Name { get; set; } #
Gets or sets the name used to identify and localize the command input parameter.
public bool IsRequired { get; set; } #
Gets or sets a value indicating whether WorkflowCommand.Validate(out string) requires a non-null value for the command input parameter.
public string DefaultValue { get; set; } #
Gets or sets the serialized default value offered for the command input.

Remarks

When a WorkflowCommand is created with a deserializer, Workflow Engine attempts to deserialize this value as ParameterDefinition.Type and stores the result in CommandParameter.DefaultValue. The default is not assigned to CommandParameter.Value automatically.
public ParameterDefinition Parameter { get; set; } #
Gets or sets the scheme-level ParameterDefinition to which the command input parameter is mapped and which determines its ParameterDefinition.Type.
public string Comment { get; set; } #
Gets or sets the descriptive comment stored with the command input in the process scheme.

Methods

public ParameterDefinitionReference Clone() #
Creates a copy of this command input parameter mapping and clones its referenced ParameterDefinition.

Returns

Type
Description
ParameterDefinitionReference
A new ParameterDefinitionReference whose ParameterDefinitionReference.Parameter is the cloned parameter definition.