Workflow Engine .NET

Assembly: OptimaJet.Workflow.Core

Class ProviderProviders<TEnumProviders>

OptimaJet.Workflow.Plugins.CustomWorkflowProviders.ProviderProviders<TEnumProviders>

Namespace: OptimaJet.Workflow.Plugins.CustomWorkflowProviders

public abstract class ProviderProviders<TEnumProviders> : ICustomMixProvider, ICustomWorkflowActionProvider, IWorkflowActionProvider, IDisableProvider, ICustomDesignerParameterFormatProvider, IDesignerParameterFormatProvider, ICustomActivityProvider, ICustomConditionProvider where TEnumProviders : struct

Inheritance

  • System.Object

Implemented Interfaces

Properties

Name
Type
Disabled #
Boolean

Methods

public List<CodeActionParameterDefinition> GetFormat(CodeActionType type, string name, string schemeCode) #
Returns parameter definitions for a specified code action

Parameters

Name
Type
Description
type
CodeActionType
Code action type CodeActionType
name
String
Name of the code action
schemeCode
String
Code of the scheme

Returns

Type
Description
List<CodeActionParameterDefinition>
A list of CodeActionParameterDefinition
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 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 void ExecuteAction(string name, ProcessInstance processInstance, WorkflowRuntime runtime, string actionParameter) #
Execute action

Parameters

Name
Type
Description
name
String
Name of the action to execute
processInstance
ProcessInstance
Reference to ProcessInstance from which action is executed ProcessInstance
runtime
WorkflowRuntime
Reference to WorkflowRuntime object which managed specified process instance WorkflowRuntime
actionParameter
String
Additional action parameter ActionDefinitionReference.ActionParameter
public Task ExecuteActionAsync(string name, ProcessInstance processInstance, WorkflowRuntime runtime, string actionParameter, CancellationToken token) #
Execute action asynchronously

Parameters

Name
Type
Description
name
String
Name of the action to execute
processInstance
ProcessInstance
Reference to ProcessInstance from which action is executed ProcessInstance
runtime
WorkflowRuntime
Reference to WorkflowRuntime object which managed specified process instance WorkflowRuntime
actionParameter
String
Additional action parameter ActionDefinitionReference.ActionParameter
token
CancellationToken
Cancellation token

Returns

Type
Description
Task
public bool ExecuteCondition(string name, ProcessInstance processInstance, WorkflowRuntime runtime, string actionParameter) #
Check condition

Parameters

Name
Type
Description
name
String
Name of the condition to check
processInstance
ProcessInstance
Reference to ProcessInstance from which condition is checked ProcessInstance
runtime
WorkflowRuntime
Reference to WorkflowRuntime object which managed specified process instance WorkflowRuntime
actionParameter
String
Additional action parameter ActionDefinitionReference.ActionParameter

Returns

Type
Description
Boolean
Condition result
public Task<bool> ExecuteConditionAsync(string name, ProcessInstance processInstance, WorkflowRuntime runtime, string actionParameter, CancellationToken token) #
Check condition asynchronously

Parameters

Name
Type
Description
name
String
Name of the condition to check
processInstance
ProcessInstance
Reference to ProcessInstance from which condition is checked ProcessInstance
runtime
WorkflowRuntime
Reference to WorkflowRuntime object which managed specified process instance WorkflowRuntime
actionParameter
String
Additional action parameter ActionDefinitionReference.ActionParameter
token
CancellationToken
Cancellation token

Returns

Type
Description
Task<Boolean>
Condition result
public List<string> GetActions(string schemeCode, NamesSearchType namesSearchType) #
Return all user actions names

Parameters

Name
Type
Description
schemeCode
String
Scheme code
namesSearchType
NamesSearchType

Returns

Type
Description
List<String>
List of actions names
public List<string> GetConditions(string schemeCode, NamesSearchType namesSearchType) #
Return all user conditions names

Parameters

Name
Type
Description
schemeCode
String
Scheme code
namesSearchType
NamesSearchType

Returns

Type
Description
List<String>
List of conditions names
public bool IsActionAsync(string name, string schemeCode) #
Checks whether the action should be called asynchronously

Parameters

Name
Type
Description
name
String
Name of the action
schemeCode
String
Scheme code

Returns

Type
Description
Boolean
public bool IsConditionAsync(string name, string schemeCode) #
Checks whether the condition should be called asynchronously

Parameters

Name
Type
Description
name
String
Name of the condition
schemeCode
String
Scheme code

Returns

Type
Description
Boolean
public List<ActivityBase> GetCustomActivities() #
Returns custom activities

Returns

Type
Description
List<ActivityBase>
public List<FormBase> GetCustomConditions() #

Returns

Type
Description
List<FormBase>

Fields

protected Dictionary<TEnumProviders, ICustomMixProvider> Providers #