Skip to main content

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
TypeDescription
List<ParameterDefinitionReference>

Comment​

Comment

Declaration
public string Comment { get; set; }
Property value
TypeDescription
string

Methods​

Create(string)​

Create CommandDefinition object

Declaration
public static CommandDefinition Create(string name)
Parameters
TypeNameDescription
stringnameName of the command
Returns
TypeDescription
CommandDefinition

AddParameterRef(string, bool, string, ParameterDefinition)​

Add the reference on the parameter to InputParameters collection

Declaration
public void AddParameterRef(string name, bool isRequired, string defaultValue, ParameterDefinition parameter)
Parameters
TypeNameDescription
stringnameName of the reference
boolisRequiredIndicates that the parameter is required
stringdefaultValueJSON serialized default value or string
ParameterDefinitionparameterParameter definition

AddParameterRef(string, ParameterDefinition)​

Add the reference on the parameter to InputParameters collection

Declaration
[Obsolete("Use AddParameterRef (string name, bool isRequired, string defaultValue, ParameterDefinition parameter). It going to be removed since 1.6.6 version.")]
public void AddParameterRef(string name, ParameterDefinition parameter)
Parameters
TypeNameDescription
stringnameName of the reference
ParameterDefinitionparameterParameter definition

Clone()​

Declaration
public CommandDefinition Clone()
Returns
TypeDescription
CommandDefinition

Clone(List<ParameterDefinition>)​

Declaration
public CommandDefinition Clone(List<ParameterDefinition> parameters)
Parameters
TypeNameDescription
List<ParameterDefinition>parameters
Returns
TypeDescription
CommandDefinition

Extension Methods​