# Class WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>

OptimaJet.Workflow.Plugins.CustomWorkflowProviders.WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>

Namespace: [OptimaJet.Workflow.Plugins.CustomWorkflowProviders](https://api.workflowengine.io/core/OptimaJet.Workflow.Plugins.CustomWorkflowProviders/)

```csharp
public abstract class WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync> : ICustomWorkflowActionProvider, IWorkflowActionProvider, IDisableProvider where TEnumActions : struct where TEnumActionsAsync : struct where TEnumConditions : struct where TEnumConditionsAsync : struct
```

## Type Hierarchy

-   WorkflowActionProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync> Current type
    -   [WorkflowActionAndDesignerParameterFormatProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>](https://api.workflowengine.io/core/OptimaJet.Workflow.Plugins.CustomWorkflowProviders/WorkflowActionAndDesignerParameterFormatProvider-TEnumActions-TEnumActionsAsync-TEnumConditions-TEnumConditionsAsync/)
        -   [CustomMixProvider<EnumActions, EnumActionsAsync, EnumConditions, EnumConditionsAsync>](https://api.workflowengine.io/core/OptimaJet.Workflow.Plugins.CustomWorkflowProviders/CustomMixProvider-EnumActions-EnumActionsAsync-EnumConditions-EnumConditionsAsync/)
            -   [CompressProvider](https://api.workflowengine.io/files-plugin/OptimaJet.Workflow.Plugins.FilesPlugin.CompressProvider/CompressProvider/)
            -   [DirectoryFTPProvider](https://api.workflowengine.io/files-plugin/OptimaJet.Workflow.Plugins.FilesPlugin.SFTPProvider.DirectoryFTPProvider/DirectoryFTPProvider/)
            -   [DirectoryProvider](https://api.workflowengine.io/files-plugin/OptimaJet.Workflow.Plugins.FilesPlugin.DirectoryProvider/DirectoryProvider/)
            -   [FileFTPProvider](https://api.workflowengine.io/files-plugin/OptimaJet.Workflow.Plugins.FilesPlugin.SFTPProvider.FileFTPProvider/FileFTPProvider/)
            -   [FileProvider](https://api.workflowengine.io/files-plugin/OptimaJet.Workflow.Plugins.FilesPlugin.FileProvider/FileProvider/)
            -   [ListFilesProvider](https://api.workflowengine.io/files-plugin/OptimaJet.Workflow.Plugins.FilesPlugin.ListFilesProvider/ListFilesProvider/)
            -   [WorkflowPlugin<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>](https://api.workflowengine.io/core/OptimaJet.Workflow.Plugins.CustomWorkflowProviders/WorkflowPlugin-TEnumActions-TEnumActionsAsync-TEnumConditions-TEnumConditionsAsync/)
                -   [ApprovalPlugin](https://api.workflowengine.io/core/OptimaJet.Workflow.Plugins/ApprovalPlugin/)
                -   [LoopPlugin](https://api.workflowengine.io/core/OptimaJet.Workflow.Plugins/LoopPlugin/)
                -   [WorkflowPluginWithRuleProvider<EnumActions, EnumActionsAsync, EnumConditions, EnumConditionsAsync, EnumRules, EnumRulesAsync>](https://api.workflowengine.io/core/OptimaJet.Workflow.Plugins.CustomWorkflowProviders/WorkflowPluginWithRuleProvider-EnumActions-EnumActionsAsync-EnumConditions-EnumConditionsAsync-EnumRules-EnumRulesAsync/)
                    -   [BasicPlugin](https://api.workflowengine.io/core/OptimaJet.Workflow.Plugins/BasicPlugin/)
    -   Implemented interfaces
        -   [ICustomWorkflowActionProvider](https://api.workflowengine.io/core/OptimaJet.Workflow.Plugins.CustomWorkflowProviders/ICustomWorkflowActionProvider/)
            -   [IDisableProvider](https://api.workflowengine.io/core/OptimaJet.Workflow.Plugins.CustomWorkflowProviders/IDisableProvider/)
            -   [IWorkflowActionProvider](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime/IWorkflowActionProvider/)

## Constructors

`public WorkflowActionProvider()` 

## Properties

`public abstract bool Disabled { get; set; }` 

`protected Dictionary<TEnumActions, ActionDelegate> Actions { get; }` 

`protected Dictionary<TEnumActionsAsync, ActionAsyncDelegate> ActionsAsync { get; }` 

`protected Dictionary<TEnumConditions, ConditionDelegate> Conditions { get; }` 

`protected Dictionary<TEnumConditionsAsync, ConditionAsyncDelegate> ConditionsAsync { get; }` 

`protected Dictionary<TEnumActions, string> ActionsDescriptions { get; }` 

`protected Dictionary<TEnumActionsAsync, string> ActionsAsyncDescriptions { get; }` 

`protected Dictionary<TEnumActionsAsync, string> ActionsAsyncTemplates { get; }` 

`protected Dictionary<TEnumConditions, string> ConditionsDescriptions { get; }` 

`protected Dictionary<TEnumConditionsAsync, string> ConditionsAsyncDescriptions { get; }` 

`protected Dictionary<TEnumConditionsAsync, string> ConditionsAsyncTemplates { get; }` 

`protected Dictionary<TEnumActions, ExcludeRule> ActionsExcludeRule { get; }` 

`protected Dictionary<TEnumActionsAsync, ExcludeRule> ActionsAsyncExcludeRule { get; }` 

`protected Dictionary<TEnumConditions, ExcludeRule> ConditionsExcludeRule { get; }` 

`protected Dictionary<TEnumConditionsAsync, ExcludeRule> ConditionsAsyncExcludeRule { get; }` 

`protected string ActionParameter { get; set; }` 

## Methods

`public void ExcludeAction(string actionName, ExcludeRule excludeRule = null)` 

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `actionName` | `String` |  |
| `excludeRule` | `ExcludeRule` |  |

`public void ExcludeCondition(string conditionName, ExcludeRule excludeRule = null)` 

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `conditionName` | `String` |  |
| `excludeRule` | `ExcludeRule` |  |

`public virtual void ExecuteAction(string name, ProcessInstance processInstance, WorkflowRuntime runtime, string actionParameter)` 

Executes an action.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `name` | `String` | Name of the action to execute. |
| `processInstance` | `ProcessInstance` | The process instance from which the action is executed. [ProcessInstance](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model/ProcessInstance/) |
| `runtime` | `WorkflowRuntime` | The runtime instance that manages the process instance. [WorkflowRuntime](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime/WorkflowRuntime/) |
| `actionParameter` | `String` | Additional action parameter value. [ActionDefinitionReference.ActionParameter](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model/ActionDefinitionReference/) |

`public virtual Task ExecuteActionAsync(string name, ProcessInstance processInstance, WorkflowRuntime runtime, string actionParameter, CancellationToken token)` 

Executes an action asynchronously.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `name` | `String` | Name of the action to execute. |
| `processInstance` | `ProcessInstance` | The process instance from which the action is executed. [ProcessInstance](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model/ProcessInstance/) |
| `runtime` | `WorkflowRuntime` | The runtime instance that manages the process instance. [WorkflowRuntime](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime/WorkflowRuntime/) |
| `actionParameter` | `String` | Additional action parameter value. [ActionDefinitionReference.ActionParameter](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model/ActionDefinitionReference/) |
| `token` | `CancellationToken` | Cancellation token. |

### Returns

| Type | Description |
| --- | --- |
| `Task` | A task that represents the asynchronous operation. |

`public virtual bool ExecuteCondition(string name, ProcessInstance processInstance, WorkflowRuntime runtime, string actionParameter)` 

Executes a condition and returns the result.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `name` | `String` | Name of the condition to check. |
| `processInstance` | `ProcessInstance` | The process instance from which the condition is checked. [ProcessInstance](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model/ProcessInstance/) |
| `runtime` | `WorkflowRuntime` | The runtime instance that manages the process instance. [WorkflowRuntime](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime/WorkflowRuntime/) |
| `actionParameter` | `String` | Additional condition parameter value. [ActionDefinitionReference.ActionParameter](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model/ActionDefinitionReference/) |

### Returns

| Type | Description |
| --- | --- |
| `Boolean` | [true](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool) if the condition evaluates to true; otherwise, [false](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool). |

`public virtual Task<bool> ExecuteConditionAsync(string name, ProcessInstance processInstance, WorkflowRuntime runtime, string actionParameter, CancellationToken token)` 

Executes a condition asynchronously and returns the result.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `name` | `String` | Name of the condition to check. |
| `processInstance` | `ProcessInstance` | The process instance from which the condition is checked. [ProcessInstance](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model/ProcessInstance/) |
| `runtime` | `WorkflowRuntime` | The runtime instance that manages the process instance. [WorkflowRuntime](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Runtime/WorkflowRuntime/) |
| `actionParameter` | `String` | Additional condition parameter value. [ActionDefinitionReference.ActionParameter](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model/ActionDefinitionReference/) |
| `token` | `CancellationToken` | Cancellation token. |

### Returns

| Type | Description |
| --- | --- |
| `Task<Boolean>` | A task that resolves to [true](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool) if the condition evaluates to true; otherwise, [false](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool). |

`public virtual List<string> GetActions(string schemeCode, NamesSearchType namesSearchType)` 

Returns action names for a scheme.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `schemeCode` | `String` | Code of the scheme for which action names are requested. |
| `namesSearchType` | `NamesSearchType` | The name selection strategy. |

### Returns

| Type | Description |
| --- | --- |
| `List<String>` | A list of action names. |

`public virtual List<string> GetConditions(string schemeCode, NamesSearchType namesSearchType)` 

Returns condition names for a scheme.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `schemeCode` | `String` | Code of the scheme for which condition names are requested. |
| `namesSearchType` | `NamesSearchType` | The name selection strategy. |

### Returns

| Type | Description |
| --- | --- |
| `List<String>` | A list of condition names. |

`public virtual bool IsActionAsync(string name, string schemeCode)` 

Checks whether an action should be executed asynchronously.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `name` | `String` | Name of the action. |
| `schemeCode` | `String` | Code of the scheme that the action belongs to. |

### Returns

| Type | Description |
| --- | --- |
| `Boolean` | [true](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool) if the action is asynchronous; otherwise, [false](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool). |

`protected List<TEnumActionsAsync> GetActionsAsync(NamesSearchType namesSearchType)` 

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `namesSearchType` | `NamesSearchType` |  |

### Returns

| Type | Description |
| --- | --- |
| `List<TEnumActionsAsync>` |  |

`protected List<TEnumActions> GetActions(NamesSearchType namesSearchType)` 

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `namesSearchType` | `NamesSearchType` |  |

### Returns

| Type | Description |
| --- | --- |
| `List<TEnumActions>` |  |

`protected List<TEnumConditions> GetConditions(NamesSearchType namesSearchType)` 

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `namesSearchType` | `NamesSearchType` |  |

### Returns

| Type | Description |
| --- | --- |
| `List<TEnumConditions>` |  |

`protected List<TEnumConditionsAsync> GetConditionsAsync(NamesSearchType namesSearchType)` 

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `namesSearchType` | `NamesSearchType` |  |

### Returns

| Type | Description |
| --- | --- |
| `List<TEnumConditionsAsync>` |  |

`public virtual bool IsConditionAsync(string name, string schemeCode)` 

Checks whether a condition should be evaluated asynchronously.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `name` | `String` | Name of the condition. |
| `schemeCode` | `String` | Code of the scheme that the condition belongs to. |

### Returns

| Type | Description |
| --- | --- |
| `Boolean` | [true](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool) if the condition is asynchronous; otherwise, [false](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool). |

`protected virtual Dictionary<string, string> ToParameters(string actionParameter)` 

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `actionParameter` | `String` |  |

### Returns

| Type | Description |
| --- | --- |
| `Dictionary<String, String>` |  |

`protected virtual Task<Dictionary<string, string>> ToParametersAsync(string actionParameter, ProcessInstance processInstance)` 

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `actionParameter` | `String` |  |
| `processInstance` | `ProcessInstance` |  |

### Returns

| Type | Description |
| --- | --- |
| `Task<String, String>` |  |

[Previous WorkflowActionAndDesignerParameterFormatProvider<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>](https://api.workflowengine.io/core/OptimaJet.Workflow.Plugins.CustomWorkflowProviders/WorkflowActionAndDesignerParameterFormatProvider-TEnumActions-TEnumActionsAsync-TEnumConditions-TEnumConditionsAsync/) [Next WorkflowPlugin<TEnumActions, TEnumActionsAsync, TEnumConditions, TEnumConditionsAsync>](https://api.workflowengine.io/core/OptimaJet.Workflow.Plugins.CustomWorkflowProviders/WorkflowPlugin-TEnumActions-TEnumActionsAsync-TEnumConditions-TEnumConditionsAsync/)