Interface ICommandParameterBuilder

Represents a builder for configuring a command parameter.

Inherited Members

ICommandBuilder.Ref(out CommandDefinition)

ICommandBuilder.CreateCommandParameter(string, ParameterDefinition)

ICommandBuilder.CreateOrUpdateCommandParameter(string, ParameterDefinition)

ICommandBuilder.UpdateCommandParameter(string)

ICommandBuilder.DeleteCommandParameter(string)

IProcessDefinitionBuilder.CreateActor(string, string)

IProcessDefinitionBuilder.CreateOrUpdateActor(string, string)

IProcessDefinitionBuilder.UpdateActor(string)

IProcessDefinitionBuilder.DeleteActor(string)

IProcessDefinitionBuilder.CreateParameter(string, Type, ParameterPurpose)

IProcessDefinitionBuilder.CreateOrUpdateParameter(string, Type, ParameterPurpose)

IProcessDefinitionBuilder.UpdateParameter(string)

IProcessDefinitionBuilder.DeleteParameter(string)

IProcessDefinitionBuilder.CreateCommand(string)

IProcessDefinitionBuilder.CreateOrUpdateCommand(string)

IProcessDefinitionBuilder.UpdateCommand(string)

IProcessDefinitionBuilder.DeleteCommand(string)

IProcessDefinitionBuilder.CreateTimer(string)

IProcessDefinitionBuilder.CreateOrUpdateTimer(string)

IProcessDefinitionBuilder.UpdateTimer(string)

IProcessDefinitionBuilder.DeleteTimer(string)

IProcessDefinitionBuilder.CreateActivity(string)

IProcessDefinitionBuilder.AddActivity(ActivityDefinition)

IProcessDefinitionBuilder.CreateInlineActivity(string, string)

IProcessDefinitionBuilder.CreateOrUpdateActivity(string)

IProcessDefinitionBuilder.CreateOrUpdateInlineActivity(string, string)

IProcessDefinitionBuilder.UpdateActivity(string)

IProcessDefinitionBuilder.UpdateInlineActivity(string)

IProcessDefinitionBuilder.UpdateActivity(ActivityDefinition)

IProcessDefinitionBuilder.UpdateInlineActivity(ActivityDefinition)

IProcessDefinitionBuilder.DeleteActivity(string)

IProcessDefinitionBuilder.DeleteActivity(ActivityDefinition)

IProcessDefinitionBuilder.CreateTransition(string, ActivityDefinition, ActivityDefinition)

IProcessDefinitionBuilder.CreateOrUpdateTransition(string, ActivityDefinition, ActivityDefinition)

IProcessDefinitionBuilder.UpdateTransition(string)

IProcessDefinitionBuilder.UpdateTransition(TransitionDefinition)

IProcessDefinitionBuilder.DeleteTransition(string)

IProcessDefinitionBuilder.DeleteTransition(TransitionDefinition)

IProcessDefinitionBuilder.ForEachActivity(Action<IActivityBuilder>)

IProcessDefinitionBuilder.ForEachTransition(Action<ITransitionBuilder>)

IProcessDefinitionBuilder.Inlined()

IProcessDefinitionBuilder.NotInlined()

IProcessDefinitionBuilder.GetActivity(string, out ActivityDefinition)

IProcessDefinitionBuilder.GetTransition(string, out TransitionDefinition)

IProcessDefinitionBuilder.ProcessDefinition

Namespace: OptimaJet.Workflow.Core.Model.Builder

Assembly: OptimaJet.Workflow.Core.dll

Syntax

public interface ICommandParameterBuilder : ICommandBuilder, IProcessDefinitionBuilder

Methods

Name(string)

Sets the name of the current parameter.

Declaration

ICommandParameterBuilder Name(string name)

Parameters

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

Returns

Type	Description
ICommandParameterBuilder	The current <xref href="OptimaJet.Workflow.Core.Model.Builder.ICommandParameterBuilder" data-throw-if-not-resolved="false"></xref> instance.

Parameter(ParameterDefinition)

Sets the parameter definition.

Declaration

ICommandParameterBuilder Parameter(ParameterDefinition parameter)

Parameters

Type	Name	Description
ParameterDefinition	parameter	The parameter definition to set.

Returns

Type	Description
ICommandParameterBuilder	The current <xref href="OptimaJet.Workflow.Core.Model.Builder.ICommandParameterBuilder" data-throw-if-not-resolved="false"></xref> instance.

Required()

Marks the parameter as required.

Declaration

ICommandParameterBuilder Required()

Returns

Type	Description
ICommandParameterBuilder	The current <xref href="OptimaJet.Workflow.Core.Model.Builder.ICommandParameterBuilder" data-throw-if-not-resolved="false"></xref> instance.

NotRequired()

Marks the parameter as not required.

Declaration

ICommandParameterBuilder NotRequired()

Returns

Type	Description
ICommandParameterBuilder	The current <xref href="OptimaJet.Workflow.Core.Model.Builder.ICommandParameterBuilder" data-throw-if-not-resolved="false"></xref> instance.

DefaultValue(string)

Sets the default value for the parameter using a string representation.

Declaration

ICommandParameterBuilder DefaultValue(string defaultValue)

Parameters

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

Returns

Type	Description
ICommandParameterBuilder	The current <xref href="OptimaJet.Workflow.Core.Model.Builder.ICommandParameterBuilder" data-throw-if-not-resolved="false"></xref> instance.

DefaultValue(object)

Sets the default value for the parameter using an object.

Declaration

ICommandParameterBuilder DefaultValue(object defaultValue)

Parameters

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

Returns

Type	Description
ICommandParameterBuilder	The current <xref href="OptimaJet.Workflow.Core.Model.Builder.ICommandParameterBuilder" data-throw-if-not-resolved="false"></xref> instance.

ClearDefaultValue()

Clears the default value of the parameter.

Declaration

ICommandParameterBuilder ClearDefaultValue()

Returns

Type	Description
ICommandParameterBuilder	The current <xref href="OptimaJet.Workflow.Core.Model.Builder.ICommandParameterBuilder" data-throw-if-not-resolved="false"></xref> instance.

CreateCommentary(string)

Creates a commentary for the parameter.

Declaration

ICommandParameterBuilder CreateCommentary(string comment)

Parameters

Type	Name	Description
string	comment	The commentary text.

Returns

Type	Description
ICommandParameterBuilder	The current <xref href="OptimaJet.Workflow.Core.Model.Builder.ICommandParameterBuilder" data-throw-if-not-resolved="false"></xref> instance.

AppendCommentary(string)

Appends text to the existing commentary of the parameter.

Declaration

ICommandParameterBuilder AppendCommentary(string comment)

Parameters

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

Returns

Type	Description
ICommandParameterBuilder	The current <xref href="OptimaJet.Workflow.Core.Model.Builder.ICommandParameterBuilder" data-throw-if-not-resolved="false"></xref> instance.

DeleteCommentary()

Deletes the commentary of the parameter.

Declaration

ICommandParameterBuilder DeleteCommentary()

Returns

Type	Description
ICommandParameterBuilder	The current <xref href="OptimaJet.Workflow.Core.Model.Builder.ICommandParameterBuilder" data-throw-if-not-resolved="false"></xref> instance.

Extension Methods

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