Workflow Engine .NET

Assembly: OptimaJet.Workflow.Core

Class LoopPlugin

OptimaJet.Workflow.Plugins.LoopPlugin

Namespace: OptimaJet.Workflow.Plugins

public class LoopPlugin : WorkflowPlugin<ActionsLoopPlugin, ActionsAsyncLoopPlugin, ConditionsLoopPlugin, ConditionsAsyncLoopPlugin>, ICustomMixProvider, ICustomWorkflowActionProvider, IWorkflowActionProvider, IDisableProvider, ICustomDesignerParameterFormatProvider, IDesignerParameterFormatProvider, ICustomActivityProvider, ICustomConditionProvider, IWorkflowPlugin

Inheritance

  • System.Object
  • OptimaJet.Workflow.Plugins.CustomWorkflowProviders.WorkflowActionProvider{OptimaJet.Workflow.Plugins.LoopsPlugin.ActionsLoopPlugin,OptimaJet.Workflow.Plugins.LoopsPlugin.ActionsAsyncLoopPlugin,OptimaJet.Workflow.Plugins.LoopsPlugin.ConditionsLoopPlugin,OptimaJet.Workflow.Plugins.LoopsPlugin.ConditionsAsyncLoopPlugin}
  • OptimaJet.Workflow.Plugins.CustomWorkflowProviders.WorkflowActionAndDesignerParameterFormatProvider{OptimaJet.Workflow.Plugins.LoopsPlugin.ActionsLoopPlugin,OptimaJet.Workflow.Plugins.LoopsPlugin.ActionsAsyncLoopPlugin,OptimaJet.Workflow.Plugins.LoopsPlugin.ConditionsLoopPlugin,OptimaJet.Workflow.Plugins.LoopsPlugin.ConditionsAsyncLoopPlugin}
  • OptimaJet.Workflow.Plugins.CustomWorkflowProviders.CustomMixProvider{OptimaJet.Workflow.Plugins.LoopsPlugin.ActionsLoopPlugin,OptimaJet.Workflow.Plugins.LoopsPlugin.ActionsAsyncLoopPlugin,OptimaJet.Workflow.Plugins.LoopsPlugin.ConditionsLoopPlugin,OptimaJet.Workflow.Plugins.LoopsPlugin.ConditionsAsyncLoopPlugin}
  • OptimaJet.Workflow.Plugins.CustomWorkflowProviders.WorkflowPlugin{OptimaJet.Workflow.Plugins.LoopsPlugin.ActionsLoopPlugin,OptimaJet.Workflow.Plugins.LoopsPlugin.ActionsAsyncLoopPlugin,OptimaJet.Workflow.Plugins.LoopsPlugin.ConditionsLoopPlugin,OptimaJet.Workflow.Plugins.LoopsPlugin.ConditionsAsyncLoopPlugin}

Implemented Interfaces

Constructors

public LoopPlugin() #

Properties

Name
Type
Name #
String
The plugin name.

Methods

protected virtual void InitialActions() #
protected virtual void InitialActionsAsync() #
public virtual Task ActionStartLoopForAsync(ProcessInstance processInstance, WorkflowRuntime runtime, Dictionary<string, string> parameters, CancellationToken token) #

Parameters

Name
Type
Description
processInstance
ProcessInstance
runtime
WorkflowRuntime
parameters
Dictionary<String>
token
CancellationToken

Returns

Type
Description
Task
public virtual Task ActionStartLoopForeachAsync(ProcessInstance processInstance, WorkflowRuntime runtime, Dictionary<string, string> parameters, CancellationToken token) #

Parameters

Name
Type
Description
processInstance
ProcessInstance
runtime
WorkflowRuntime
parameters
Dictionary<String>
token
CancellationToken

Returns

Type
Description
Task
public virtual Task ActionStartLoopForeachFromParameterAsync(ProcessInstance processInstance, WorkflowRuntime runtime, Dictionary<string, string> parameters, CancellationToken token) #

Parameters

Name
Type
Description
processInstance
ProcessInstance
runtime
WorkflowRuntime
parameters
Dictionary<String>
token
CancellationToken

Returns

Type
Description
Task
public virtual Task ActionSetLoopStateAsync(ProcessInstance processInstance, WorkflowRuntime runtime, Dictionary<string, string> parameters, CancellationToken token) #

Parameters

Name
Type
Description
processInstance
ProcessInstance
runtime
WorkflowRuntime
parameters
Dictionary<String>
token
CancellationToken

Returns

Type
Description
Task
protected virtual void InitialConditions() #
protected virtual void InitialConditionsAsync() #
public virtual Task<bool> ConditionLoopIsBrokenAsync(ProcessInstance processInstance, WorkflowRuntime runtime, Dictionary<string, string> parameters, CancellationToken token) #

Parameters

Name
Type
Description
processInstance
ProcessInstance
runtime
WorkflowRuntime
parameters
Dictionary<String>
token
CancellationToken

Returns

Type
Description
Task<Boolean>
public virtual Task<bool> ConditionLoopIsCompletedAsync(ProcessInstance processInstance, WorkflowRuntime runtime, Dictionary<string, string> parameters, CancellationToken token) #

Parameters

Name
Type
Description
processInstance
ProcessInstance
runtime
WorkflowRuntime
parameters
Dictionary<String>
token
CancellationToken

Returns

Type
Description
Task<Boolean>
public virtual Task<bool> ConditionLoopIsCompletedOrBrokenAsync(ProcessInstance processInstance, WorkflowRuntime runtime, Dictionary<string, string> parameters, CancellationToken token) #

Parameters

Name
Type
Description
processInstance
ProcessInstance
runtime
WorkflowRuntime
parameters
Dictionary<String>
token
CancellationToken

Returns

Type
Description
Task<Boolean>
public virtual Task<bool> ConditionLoopIsDefaultAsync(ProcessInstance processInstance, WorkflowRuntime runtime, Dictionary<string, string> parameters, CancellationToken token) #

Parameters

Name
Type
Description
processInstance
ProcessInstance
runtime
WorkflowRuntime
parameters
Dictionary<String>
token
CancellationToken

Returns

Type
Description
Task<Boolean>
public virtual Task<bool> ConditionLoopIsNotDefaultAsync(ProcessInstance processInstance, WorkflowRuntime runtime, Dictionary<string, string> parameters, CancellationToken token) #

Parameters

Name
Type
Description
processInstance
ProcessInstance
runtime
WorkflowRuntime
parameters
Dictionary<String>
token
CancellationToken

Returns

Type
Description
Task<Boolean>
public virtual Task<bool> ConditionLoopIsNotCompletedAndBrokenAsync(ProcessInstance processInstance, WorkflowRuntime runtime, Dictionary<string, string> parameters, CancellationToken token) #

Parameters

Name
Type
Description
processInstance
ProcessInstance
runtime
WorkflowRuntime
parameters
Dictionary<String>
token
CancellationToken

Returns

Type
Description
Task<Boolean>
protected virtual Task<LoopState> GetLoopStateAsync(ProcessInstance processInstance, Dictionary<string, string> parameters) #

Parameters

Name
Type
Description
processInstance
ProcessInstance
parameters
Dictionary<String>

Returns

Type
Description
Task<LoopState>
protected virtual void InitialFormatsActions() #
protected virtual void InitialFormatsActionsAsync() #
protected virtual void InitialFormatsConditions() #
protected virtual void InitialActionsAsyncTemplates() #
protected virtual void InitialFormatsConditionsAsync() #
public virtual List<CodeActionParameterDefinition> FormatStartLoopFor() #

Returns

Type
Description
List<CodeActionParameterDefinition>
public virtual List<CodeActionParameterDefinition> FormatStartLoopForeach() #

Returns

Type
Description
List<CodeActionParameterDefinition>
public virtual List<CodeActionParameterDefinition> FormatStartLoopForeachFromParameter() #

Returns

Type
Description
List<CodeActionParameterDefinition>
public virtual List<CodeActionParameterDefinition> FormatSetLoopState() #

Returns

Type
Description
List<CodeActionParameterDefinition>
public virtual List<CodeActionParameterDefinition> FormatLoopIsBroken() #

Returns

Type
Description
List<CodeActionParameterDefinition>
public virtual List<CodeActionParameterDefinition> FormatLoopIsCompleted() #

Returns

Type
Description
List<CodeActionParameterDefinition>
public virtual List<CodeActionParameterDefinition> FormatLoopIsCompletedOrBroken() #

Returns

Type
Description
List<CodeActionParameterDefinition>
public virtual List<CodeActionParameterDefinition> FormatLoopIsDefault() #

Returns

Type
Description
List<CodeActionParameterDefinition>
public virtual List<CodeActionParameterDefinition> FormatLoopIsNotCompletedAndBroken() #

Returns

Type
Description
List<CodeActionParameterDefinition>
public virtual List<CodeActionParameterDefinition> FormatLoopIsNotDefault() #

Returns

Type
Description
List<CodeActionParameterDefinition>
protected virtual void InitialExclude() #
public override void OnPluginAdd(WorkflowRuntime runtime, List<string> schemes = null) #
Called when a plugin is added to a runtime.

Parameters

Name
Type
Description
runtime
WorkflowRuntime
The instance of the runtime.
schemes
List<String>
The list of schemes for which the plugin is being added.