Interface ICommandBuilder
OptimaJet.Workflow.Core.Model.Builder.ICommandBuilder
Represents a builder for configuring a command.
Namespace: OptimaJet.Workflow.Core.Model.Builder
public interface ICommandBuilder : IProcessDefinitionBuilderMethods
ICommandBuilder Ref(out CommandDefinition commandDefinition) #Sets the reference to the current command definition.
Parameters
Name
Type
Description
commandDefinitionCommandDefinitionThe command definition reference.
Returns
Type
Description
ICommandBuilderThe current instance of ICommandBuilder.
ICommandBuilder Name(string name) #Sets the name of the current command.
Parameters
Name
Type
Description
nameStringThe name of the command.
Returns
Type
Description
ICommandBuilderThe current instance of ICommandBuilder.
ICommandParameterBuilder CreateCommandParameter(string name, ParameterDefinition parameter) #Creates a new command parameter with the specified name and parameter definition.
Parameters
Name
Type
Description
nameStringThe name of the parameter.
parameterParameterDefinitionThe parameter definition.
Returns
Type
Description
ICommandParameterBuilderAn instance of ICommandParameterBuilder for further parameter configuration.
ICommandParameterBuilder CreateOrUpdateCommandParameter(string name, ParameterDefinition parameter) #Creates or updates a command parameter with the specified name and parameter definition.
Parameters
Name
Type
Description
nameStringThe name of the parameter.
parameterParameterDefinitionThe parameter definition.
Returns
Type
Description
ICommandParameterBuilderAn instance of ICommandParameterBuilder for further parameter configuration.
ICommandParameterBuilder UpdateCommandParameter(string name) #Updates an existing command parameter with the specified name.
Parameters
Name
Type
Description
nameStringThe name of the parameter to update.
Returns
Type
Description
ICommandParameterBuilderAn instance of ICommandParameterBuilder for further parameter configuration.
ICommandBuilder DeleteCommandParameter(string name) #Deletes a command parameter with the specified name.
Parameters
Name
Type
Description
nameStringThe name of the parameter to delete.
Returns
Type
Description
ICommandBuilderThe current instance of ICommandBuilder.
ICommandBuilder CreateCommentary(string comment) #Creates a commentary for the current command.
Parameters
Name
Type
Description
commentStringThe commentary text.
Returns
Type
Description
ICommandBuilderThe current instance of ICommandBuilder.
ICommandBuilder AppendCommentary(string comment) #Appends additional commentary to the current command.
Parameters
Name
Type
Description
commentStringThe additional commentary text.
Returns
Type
Description
ICommandBuilderThe current instance of ICommandBuilder.
ICommandBuilder DeleteCommentary() #Deletes the commentary from the current command.
Returns
Type
Description
ICommandBuilderThe current instance of ICommandBuilder.
ICommandBuilder CreateOrUpdateLocalization(CultureInfo culture, string value, bool isDefault = false) #Adds or updates localization for the current command.
Parameters
Name
Type
Description
cultureCultureInfoCulture (language) for which the localization value applies.
valueStringCommand name in the specified culture.
isDefaultBooleanIf set to true, this indicates that the record will be used as the default when a record with the specified culture is unavailable.
Returns
Type
Description
ICommandBuilderThe current instance of ICommandBuilder.
ICommandBuilder DeleteLocalization(CultureInfo culture) #Removes localization for the current command in the specified culture.
Parameters
Name
Type
Description
cultureCultureInfoCulture (language) for which the localization value is removed.
Returns
Type
Description
ICommandBuilderThe current instance of ICommandBuilder.
ICommandBuilder DeleteAllLocalizations() #Removes all localizations for the current command.
Returns
Type
Description
ICommandBuilderThe current instance of ICommandBuilder.