Skip to main content

Class ParameterDefinition

Represent a parameter in a process scheme

Inheritance​

↳ object

    ↳ BaseDefinition

        ↳ ParameterDefinition

            ↳ ParameterDefinitionWithValue

Inherited Members​

BaseDefinition.Name

BaseDefinition.DesignerSettings

Equals(object)

Equals(object, object)

GetHashCode()

GetType()

MemberwiseClone()

ReferenceEquals(object, object)

ToString()

Namespace: OptimaJet.Workflow.Core.Model

Assembly: OptimaJet.Workflow.Core.dll

Syntax
public class ParameterDefinition : BaseDefinition

Properties​

Type​

Type of the parameter

Declaration
[JsonConverter(typeof(StringTypeConverter))]
public virtual Type Type { get; set; }
Property value
TypeDescription
Type

Purpose​

Specifies the method of storing parameters ParameterPurpose

Declaration
[JsonConverter(typeof(StringEnumConverter))]
public virtual ParameterPurpose Purpose { get; set; }
Property value
TypeDescription
ParameterPurpose

InitialValue​

Serialized default value of the parameter

Declaration
public virtual string InitialValue { get; set; }
Property value
TypeDescription
string

Methods​

Create(string, string, string, string, bool)​

Create ParameterDefinition object

Declaration
public static ParameterDefinition Create(string name, string type, string purpose, string initialValue, bool ignoreTypeExistenceCheck = false)
Parameters
TypeNameDescription
stringnameName of the parameter
stringtypeType of the parameter
stringpurposeSpecifies the method of storing parameters <xref href="OptimaJet.Workflow.Core.Model.ParameterPurpose" data-throw-if-not-resolved="false"></xref>
stringinitialValueSerialized default value of the parameter
boolignoreTypeExistenceCheckIf true the parameter type missing will be ignored
Returns
TypeDescription
ParameterDefinitionParameterDefinition object

Create(string, Type, ParameterPurpose, string)​

Create ParameterDefinition object

Declaration
public static ParameterDefinition Create(string name, Type type, ParameterPurpose purpose, string initialValue = null)
Parameters
TypeNameDescription
stringnameName of the parameter
TypetypeType of the parameter
ParameterPurposepurposeSpecifies the method of storing parameters <xref href="OptimaJet.Workflow.Core.Model.ParameterPurpose" data-throw-if-not-resolved="false"></xref>
stringinitialValueSerialized default value of the parameter
Returns
TypeDescription
ParameterDefinitionParameterDefinition object

Create(string, string, string, bool)​

Create ParameterDefinition object

Declaration
public static ParameterDefinition Create(string name, string type, string initialValue, bool ignoreTypeExistenceCheck = false)
Parameters
TypeNameDescription
stringnameName of the parameter
stringtypeType of the parameter
stringinitialValueSerialized default value of the parameter
boolignoreTypeExistenceCheckIf true the parameter type missing will be ignored
Returns
TypeDescription
ParameterDefinitionParameterDefinition object

Create(ParameterDefinition, object)​

Create ParameterDefinitionWithValue object

Declaration
public static ParameterDefinitionWithValue Create(ParameterDefinition parameterDefinition, object value)
Parameters
TypeNameDescription
ParameterDefinitionparameterDefinitionParameter object
objectvalueValue of the parameter
Returns
TypeDescription
ParameterDefinitionWithValue

Clone()​

Declaration
public ParameterDefinition Clone()
Returns
TypeDescription
ParameterDefinition

Extension Methods​