Workflow Engine .NET

Assembly: OptimaJet.Workflow.Core

Interface IParameterBuilder

OptimaJet.Workflow.Core.Model.Builder.IParameterBuilder

Represents a builder for configuring a parameter definition.

Namespace: OptimaJet.Workflow.Core.Model.Builder

public interface IParameterBuilder : IProcessDefinitionBuilder

Methods

IParameterBuilder Ref(out ParameterDefinition parameterDefinition) #
Assigns the current parameter definition to an output variable.

Parameters

Name
Type
Description
parameterDefinition
ParameterDefinition
The output variable to store the current parameter definition.

Returns

Type
Description
IParameterBuilder
Returns the current instance of IParameterBuilder.
IParameterBuilder Name(string name) #
Sets the name of the parameter.

Parameters

Name
Type
Description
name
String
The name to assign to the parameter.

Returns

Type
Description
IParameterBuilder
Returns the current instance of IParameterBuilder.
IParameterBuilder Purpose(ParameterPurpose purpose) #
Sets the purpose of the parameter.

Parameters

Name
Type
Description
purpose
ParameterPurpose
The purpose to assign to the parameter.

Returns

Type
Description
IParameterBuilder
Returns the current instance of IParameterBuilder.
IParameterBuilder Type(Type type) #
Sets the type of the parameter.

Parameters

Name
Type
Description
type
Type
The type to assign to the parameter.

Returns

Type
Description
IParameterBuilder
Returns the current instance of IParameterBuilder.
IParameterBuilder InitialValue(string initialValue) #
Sets the initial value of the parameter from a string.

Parameters

Name
Type
Description
initialValue
String
The initial value to assign to the parameter.

Returns

Type
Description
IParameterBuilder
Returns the current instance of IParameterBuilder.
IParameterBuilder InitialValue(object initialValue) #
Sets the initial value of the parameter from an object.

Parameters

Name
Type
Description
initialValue
Object
The initial value to assign to the parameter.

Returns

Type
Description
IParameterBuilder
Returns the current instance of IParameterBuilder.
IParameterBuilder ClearInitialValue() #
Clears the initial value of the parameter.

Returns

Type
Description
IParameterBuilder
Returns the current instance of IParameterBuilder.