using System.Collections.Generic;

using System.Threading;

using System.Threading.Tasks;

using OptimaJet.Workflow.Core.Model;

namespace OptimaJet.Workflow.Core.Runtime

{

/// <summary>

/// Interface of a action provider, which provide execution of actions specified in activities <see cref="ActivityDefinition.Implementation"/> and <see cref="ActivityDefinition.PreExecutionImplementation"/>

/// and execution of conditions <see cref="ConditionDefinition.Action"/>

/// </summary>

public interface IWorkflowActionProvider

{

/// <summary>

/// Execute action

/// </summary>

/// <param name="name">Name of the action to execute</param>

/// <param name="processInstance">Reference to ProcessInstance from which action is executed <see cref="ProcessInstance"/></param>

/// <param name="runtime">Reference to WorkflowRuntime object which managed specified process instance <see cref="WorkflowRuntime"/></param>

/// <param name="actionParameter">Additional action parameter <see cref="ActionDefinitionReference.ActionParameter"/></param>

void ExecuteAction(string name, ProcessInstance processInstance, WorkflowRuntime runtime, string actionParameter);

/// <summary>

/// Execute action asynchronously

/// </summary>

/// <param name="name">Name of the action to execute</param>

/// <param name="processInstance">Reference to ProcessInstance from which action is executed <see cref="ProcessInstance"/></param>

/// <param name="runtime">Reference to WorkflowRuntime object which managed specified process instance <see cref="WorkflowRuntime"/></param>

/// <param name="actionParameter">Additional action parameter <see cref="ActionDefinitionReference.ActionParameter"/></param>

/// <param name="token">Cancellation token</param>

Task ExecuteActionAsync(string name, ProcessInstance processInstance, WorkflowRuntime runtime, string actionParameter, CancellationToken token);

/// <summary>

/// Check condition

/// </summary>

/// <param name="name">Name of the condition to check</param>

/// <param name="processInstance">Reference to ProcessInstance from which condition is checked <see cref="ProcessInstance"/></param>

/// <param name="runtime">Reference to WorkflowRuntime object which managed specified process instance <see cref="WorkflowRuntime"/></param>

/// <param name="actionParameter">Additional action parameter <see cref="ActionDefinitionReference.ActionParameter"/></param>

/// <returns>Condition result</returns>

bool ExecuteCondition(string name, ProcessInstance processInstance, WorkflowRuntime runtime,

string actionParameter);

/// <summary>

/// Check condition asynchronously

/// </summary>

/// <param name="name">Name of the condition to check</param>

/// <param name="processInstance">Reference to ProcessInstance from which condition is checked <see cref="ProcessInstance"/></param>

/// <param name="runtime">Reference to WorkflowRuntime object which managed specified process instance <see cref="WorkflowRuntime"/></param>

/// <param name="actionParameter">Additional action parameter <see cref="ActionDefinitionReference.ActionParameter"/></param>

/// <param name="token">Cancellation token</param>

/// <returns>Condition result</returns>

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

/// <summary>

/// Checks whether the action should be called asynchronously

/// </summary>

/// <param name="name">Name of the action</param>

/// <param name="schemeCode">Scheme code</param>

bool IsActionAsync(string name, string schemeCode);

/// <summary>

/// Checks whether the condition should be called asynchronously

/// </summary>

/// <param name="name">Name of the condition</param>

/// <param name="schemeCode">Scheme code</param>

bool IsConditionAsync(string name, string schemeCode);

/// <summary>

/// Return all user actions names

/// </summary>

/// <param name="schemeCode">Scheme code</param>

/// <returns>List of actions names</returns>

List<string> GetActions(string schemeCode);

/// <summary>

/// Return all user conditions names

/// </summary>

/// <param name="schemeCode">Scheme code</param>

/// <returns>List of conditions names</returns>

List<string> GetConditions(string schemeCode);

}

}