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

Type	Description
Type

Purpose

Specifies the method of storing parameters ParameterPurpose

Declaration

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

Property value

Type	Description
ParameterPurpose

InitialValue

Serialized default value of the parameter

Declaration

public virtual string InitialValue { get; set; }

Property value

Type	Description
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

Type	Name	Description
string	name	Name of the parameter
string	type	Type of the parameter
string	purpose	Specifies the method of storing parameters <xref href="OptimaJet.Workflow.Core.Model.ParameterPurpose" data-throw-if-not-resolved="false"></xref>
string	initialValue	Serialized default value of the parameter
bool	ignoreTypeExistenceCheck	If true the parameter type missing will be ignored

Returns

Type	Description
ParameterDefinition	ParameterDefinition object

Create(string, Type, ParameterPurpose, string)

Create ParameterDefinition object

Declaration

public static ParameterDefinition Create(string name, Type type, ParameterPurpose purpose, string initialValue = null)

Parameters

Type	Name	Description
string	name	Name of the parameter
Type	type	Type of the parameter
ParameterPurpose	purpose	Specifies the method of storing parameters <xref href="OptimaJet.Workflow.Core.Model.ParameterPurpose" data-throw-if-not-resolved="false"></xref>
string	initialValue	Serialized default value of the parameter

Returns

Type	Description
ParameterDefinition	ParameterDefinition object

Create(string, string, string, bool)

Create ParameterDefinition object

Declaration

public static ParameterDefinition Create(string name, string type, string initialValue, bool ignoreTypeExistenceCheck = false)

Parameters

Type	Name	Description
string	name	Name of the parameter
string	type	Type of the parameter
string	initialValue	Serialized default value of the parameter
bool	ignoreTypeExistenceCheck	If true the parameter type missing will be ignored

Returns

Type	Description
ParameterDefinition	ParameterDefinition object

Create(ParameterDefinition, object)

Create ParameterDefinitionWithValue object

Declaration

public static ParameterDefinitionWithValue Create(ParameterDefinition parameterDefinition, object value)

Parameters

Type	Name	Description
ParameterDefinition	parameterDefinition	Parameter object
object	value	Value of the parameter

Returns

Type	Description
ParameterDefinitionWithValue

Clone()

Declaration

public ParameterDefinition Clone()

Returns

Type	Description
ParameterDefinition

Extension Methods

• Extensions.CastAs<T>(object)
• Extensions.ExtendedEquals(object, object)
• Extensions.TryCast<T>(object, out T)