Workflow Engine .NET

Assembly: OptimaJet.Workflow.Core

Interface ICommandParameterBuilder

OptimaJet.Workflow.Core.Model.Builder.ICommandParameterBuilder

Represents a builder for configuring a command parameter.

Namespace: OptimaJet.Workflow.Core.Model.Builder

public interface ICommandParameterBuilder : ICommandBuilder, IProcessDefinitionBuilder

Methods

ICommandParameterBuilder Name(string name) #
Sets the name of the current parameter.

Parameters

Name
Type
Description
name
String
The name to set for the parameter.

Returns

Type
Description
ICommandParameterBuilder
The current ICommandParameterBuilder instance.
ICommandParameterBuilder Parameter(ParameterDefinition parameter) #
Sets the parameter definition.

Parameters

Name
Type
Description
parameter
ParameterDefinition
The parameter definition to set.

Returns

Type
Description
ICommandParameterBuilder
The current ICommandParameterBuilder instance.
ICommandParameterBuilder Required() #
Marks the parameter as required.

Returns

Type
Description
ICommandParameterBuilder
The current ICommandParameterBuilder instance.
ICommandParameterBuilder NotRequired() #
Marks the parameter as not required.

Returns

Type
Description
ICommandParameterBuilder
The current ICommandParameterBuilder instance.
ICommandParameterBuilder DefaultValue(string defaultValue) #
Sets the default value for the parameter using a string representation.

Parameters

Name
Type
Description
defaultValue
String
The default value as a string.

Returns

Type
Description
ICommandParameterBuilder
The current ICommandParameterBuilder instance.
ICommandParameterBuilder DefaultValue(object defaultValue) #
Sets the default value for the parameter using an object.

Parameters

Name
Type
Description
defaultValue
Object
The default value as an object.

Returns

Type
Description
ICommandParameterBuilder
The current ICommandParameterBuilder instance.
ICommandParameterBuilder ClearDefaultValue() #
Clears the default value of the parameter.

Returns

Type
Description
ICommandParameterBuilder
The current ICommandParameterBuilder instance.
ICommandParameterBuilder CreateCommentary(string comment) #
Creates a commentary for the parameter.

Parameters

Name
Type
Description
comment
String
The commentary text.

Returns

Type
Description
ICommandParameterBuilder
The current ICommandParameterBuilder instance.
ICommandParameterBuilder AppendCommentary(string comment) #
Appends text to the existing commentary of the parameter.

Parameters

Name
Type
Description
comment
String
The text to append to the commentary.

Returns

Type
Description
ICommandParameterBuilder
The current ICommandParameterBuilder instance.
ICommandParameterBuilder DeleteCommentary() #
Deletes the commentary of the parameter.

Returns

Type
Description
ICommandParameterBuilder
The current ICommandParameterBuilder instance.