Interface ICommandBuilder

Represents a builder for configuring a command.

Inherited Members

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.CreateOrUpdateLocalizationForState(string, CultureInfo, string, bool)

IProcessDefinitionBuilder.DeleteLocalizationForState(string, CultureInfo)

IProcessDefinitionBuilder.DeleteAllLocalizationsForState(string)

IProcessDefinitionBuilder.ProcessDefinition

Namespace: OptimaJet.Workflow.Core.Model.Builder

Assembly: OptimaJet.Workflow.Core.dll

Syntax

public interface ICommandBuilder : IProcessDefinitionBuilder

Methods

Ref(out CommandDefinition)

Sets the reference to the current command definition.

Declaration

ICommandBuilder Ref(out CommandDefinition commandDefinition)

Parameters

Type	Name	Description
CommandDefinition	commandDefinition	The command definition reference.

Returns

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

Name(string)

Sets the name of the current command.

Declaration

ICommandBuilder Name(string name)

Parameters

Type	Name	Description
string	name	The name of the command.

Returns

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

CreateCommandParameter(string, ParameterDefinition)

Creates a new command parameter with the specified name and parameter definition.

Declaration

ICommandParameterBuilder CreateCommandParameter(string name, ParameterDefinition parameter)

Parameters

Type	Name	Description
string	name	The name of the parameter.
ParameterDefinition	parameter	The parameter definition.

Returns

Type	Description
ICommandParameterBuilder	An instance of <xref href="OptimaJet.Workflow.Core.Model.Builder.ICommandParameterBuilder" data-throw-if-not-resolved="false"></xref> for further parameter configuration.

CreateOrUpdateCommandParameter(string, ParameterDefinition)

Creates or updates a command parameter with the specified name and parameter definition.

Declaration

ICommandParameterBuilder CreateOrUpdateCommandParameter(string name, ParameterDefinition parameter)

Parameters

Type	Name	Description
string	name	The name of the parameter.
ParameterDefinition	parameter	The parameter definition.

Returns

Type	Description
ICommandParameterBuilder	An instance of <xref href="OptimaJet.Workflow.Core.Model.Builder.ICommandParameterBuilder" data-throw-if-not-resolved="false"></xref> for further parameter configuration.

UpdateCommandParameter(string)

Updates an existing command parameter with the specified name.

Declaration

ICommandParameterBuilder UpdateCommandParameter(string name)

Parameters

Type	Name	Description
string	name	The name of the parameter to update.

Returns

Type	Description
ICommandParameterBuilder	An instance of <xref href="OptimaJet.Workflow.Core.Model.Builder.ICommandParameterBuilder" data-throw-if-not-resolved="false"></xref> for further parameter configuration.

DeleteCommandParameter(string)

Deletes a command parameter with the specified name.

Declaration

ICommandBuilder DeleteCommandParameter(string name)

Parameters

Type	Name	Description
string	name	The name of the parameter to delete.

Returns

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

CreateCommentary(string)

Creates a commentary for the current command.

Declaration

ICommandBuilder CreateCommentary(string comment)

Parameters

Type	Name	Description
string	comment	The commentary text.

Returns

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

AppendCommentary(string)

Appends additional commentary to the current command.

Declaration

ICommandBuilder AppendCommentary(string comment)

Parameters

Type	Name	Description
string	comment	The additional commentary text.

Returns

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

DeleteCommentary()

Deletes the commentary from the current command.

Declaration

ICommandBuilder DeleteCommentary()

Returns

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

CreateOrUpdateLocalization(CultureInfo, string, bool)

Adds or updates localization for the current command.

Declaration

ICommandBuilder CreateOrUpdateLocalization(CultureInfo culture, string value, bool isDefault = false)

Parameters

Type	Name	Description
CultureInfo	culture	Culture (language) for which the localization value applies.
string	value	Command name in the specified culture.
bool	isDefault	If 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
ICommandBuilder	The current instance of <xref href="OptimaJet.Workflow.Core.Model.Builder.ICommandBuilder" data-throw-if-not-resolved="false"></xref>.

DeleteLocalization(CultureInfo)

Removes localization for the current command in the specified culture.

Declaration

ICommandBuilder DeleteLocalization(CultureInfo culture)

Parameters

Type	Name	Description
CultureInfo	culture	Culture (language) for which the localization value is removed.

Returns

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

DeleteAllLocalizations()

Removes all localizations for the current command.

Declaration

ICommandBuilder DeleteAllLocalizations()

Returns

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

Extension Methods

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