Class CommandDefinition

Represent a command in a process scheme

Inheritance

↳ object

    ↳ BaseDefinition

        ↳ CommandDefinition

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 CommandDefinition : BaseDefinition

Properties

InputParameters

List of references on parameters ParameterDefinitionReference

Declaration

public List<ParameterDefinitionReference> InputParameters { get; set; }

Property value

Type	Description
List<ParameterDefinitionReference>

Comment

Comment

Declaration

public string Comment { get; set; }

Property value

Type	Description
string

Methods

Create(string)

Create CommandDefinition object

Declaration

public static CommandDefinition Create(string name)

Parameters

Type	Name	Description
string	name	Name of the command

Returns

Type	Description
CommandDefinition

AddParameterRef(ParameterDefinitionReference, ParameterDefinition)

Add the reference on the parameter to InputParameters collection

Declaration

public void AddParameterRef(ParameterDefinitionReference parameterDefinitionReference, ParameterDefinition parameter)

Parameters

Type	Name	Description
ParameterDefinitionReference	parameterDefinitionReference	Reference to parameter definition
ParameterDefinition	parameter	Parameter definition

AddParameterRef(string, bool, string, ParameterDefinition)

Add the reference on the parameter to InputParameters collection

Declaration

[Obsolete("Use AddParameterRef (ParameterDefinitionReference parameterDefinitionReference, ParameterDefinition parameter).")]
public void AddParameterRef(string name, bool isRequired, string defaultValue, ParameterDefinition parameter)

Parameters

Type	Name	Description
string	name	Name of the reference
bool	isRequired	Indicates that the parameter is required
string	defaultValue	JSON serialized default value or string
ParameterDefinition	parameter	Parameter definition

AddParameterRef(string, ParameterDefinition)

Add the reference on the parameter to InputParameters collection

Declaration

[Obsolete("Use AddParameterRef (ParameterDefinitionReference parameterDefinitionReference, ParameterDefinition parameter). It going to be removed since 1.6.6 version.")]
public void AddParameterRef(string name, ParameterDefinition parameter)

Parameters

Type	Name	Description
string	name	Name of the reference
ParameterDefinition	parameter	Parameter definition

Clone()

Declaration

public CommandDefinition Clone()

Returns

Type	Description
CommandDefinition

Clone(List<ParameterDefinition>)

Declaration

public CommandDefinition Clone(List<ParameterDefinition> parameters)

Parameters

Type	Name	Description
List<ParameterDefinition>	parameters

Returns

Type	Description
CommandDefinition

Extension Methods

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