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 : structType Hierarchy
- ProviderProviders<TEnumProviders> Current type
Properties
public bool Disabled { get; set; } #Methods
public List<CodeActionParameterDefinition> GetFormat(CodeActionType type, string name, string schemeCode) #Gets the ordered form-field definitions for a named action, condition, or rule.
Parameters
Name
Type
Description
typeCodeActionTypeThe parameter usage context: CodeActionType.Action, CodeActionType.Condition, CodeActionType.RuleCheck, or CodeActionType.RuleGet.
nameStringThe action, condition, or rule name selected in the Designer.
schemeCodeStringThe current process scheme code, which can be used to provide scheme-specific fields. The value may be null when the format is requested without a process scheme context.
Returns
Type
Description
List<CodeActionParameterDefinition>An ordered list containing one CodeActionParameterDefinition per form field. Returning null or an empty list indicates that no structured parameter editor is defined; the Designer then uses its raw JSON editor.
public void ExcludeAction_(string actionName, ExcludeRule excludeRule = null) #Parameters
Name
Type
Description
actionNameStringexcludeRuleExcludeRulepublic void ExcludeCondition_(string conditionName, ExcludeRule excludeRule = null) #Parameters
Name
Type
Description
conditionNameStringexcludeRuleExcludeRulepublic void ExcludeAction(string actionName, ExcludeRule excludeRule = null) #Parameters
Name
Type
Description
actionNameStringexcludeRuleExcludeRulepublic void ExcludeCondition(string conditionName, ExcludeRule excludeRule = null) #Parameters
Name
Type
Description
conditionNameStringexcludeRuleExcludeRulepublic void ExecuteAction(string name, ProcessInstance processInstance, WorkflowRuntime runtime, string actionParameter) #Executes an action.
Parameters
Name
Type
Description
nameStringName of the action to execute.
processInstanceProcessInstanceThe process instance from which the action is executed. ProcessInstance
public Task ExecuteActionAsync(string name, ProcessInstance processInstance, WorkflowRuntime runtime, string actionParameter, CancellationToken token) #Executes an action asynchronously.
Parameters
Name
Type
Description
nameStringName of the action to execute.
processInstanceProcessInstanceThe process instance from which the action is executed. ProcessInstance
tokenCancellationTokenCancellation token.
Returns
Type
Description
TaskA task that represents the asynchronous operation.
public bool ExecuteCondition(string name, ProcessInstance processInstance, WorkflowRuntime runtime, string actionParameter) #Executes a condition and returns the result.
Parameters
Name
Type
Description
nameStringName of the condition to check.
processInstanceProcessInstanceThe process instance from which the condition is checked. ProcessInstance
actionParameterStringAdditional condition parameter value. ActionDefinitionReference.ActionParameter
Returns
public 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
nameStringName of the condition to check.
processInstanceProcessInstanceThe process instance from which the condition is checked. ProcessInstance
actionParameterStringAdditional condition parameter value. ActionDefinitionReference.ActionParameter
tokenCancellationTokenCancellation token.
Returns
public List<string> GetActions(string schemeCode, NamesSearchType namesSearchType) #Returns action names for a scheme.
Parameters
Name
Type
Description
schemeCodeStringCode of the scheme for which action names are requested.
namesSearchTypeNamesSearchTypeThe name selection strategy.
Returns
Type
Description
List<String>A list of action names.
public List<string> GetConditions(string schemeCode, NamesSearchType namesSearchType) #Returns condition names for a scheme.
Parameters
Name
Type
Description
schemeCodeStringCode of the scheme for which condition names are requested.
namesSearchTypeNamesSearchTypeThe name selection strategy.
Returns
Type
Description
List<String>A list of condition names.
public bool IsActionAsync(string name, string schemeCode) #Checks whether an action should be executed asynchronously.
public bool IsConditionAsync(string name, string schemeCode) #Checks whether a condition should be evaluated asynchronously.
public List<ActivityBase> GetCustomActivities() #Gets the custom activities exposed by the provider.
Returns
Type
Description
List<ActivityBase>A list of custom ActivityBase instances available from this provider.
public List<FormBase> GetCustomConditions() #Returns
Type
Description
List<FormBase>Fields
protected Dictionary<TEnumProviders, ICustomMixProvider> Providers #