Interface IProcessExecutor

Provides a set of methods for executing business processes.

Namespace: Terrasoft.Core.Process

Assembly: Terrasoft.Core.dll

Syntax

public interface IProcessExecutor

Methods

CancelExecutionAsync(Guid)

Asynchronously cancels process execution.

Declaration

void CancelExecutionAsync(Guid processId)

Parameters

Type	Name	Description
System.Guid	processId	Identifier of the process.

Execute(Guid)

Executes process with corresponding schema UId.

Declaration

ProcessDescriptor Execute(Guid processSchemaUId)

Parameters

Type	Name	Description
System.Guid	processSchemaUId	UId of process schema.

Returns

Type	Description
ProcessDescriptor	Process description data.

Execute(Guid, IEnumerable<String>)

Executes process with corresponding schema UId.

Declaration

ProcessDescriptor Execute(Guid processSchemaUId, IEnumerable<string> resultParameterNames)

Parameters

Type	Name	Description
System.Guid	processSchemaUId	UId of process schema.
System.Collections.Generic.IEnumerable<System.String>	resultParameterNames	Result parameter names to read.

Returns

Type	Description
ProcessDescriptor	Process description data.

Execute(Guid, IReadOnlyDictionary<String, String>)

Executes process with corresponding schema UId.

Declaration

ProcessDescriptor Execute(Guid processSchemaUId, IReadOnlyDictionary<string, string> parameterValues)

Parameters

Type	Name	Description
System.Guid	processSchemaUId	UId of process schema.
System.Collections.Generic.IReadOnlyDictionary<System.String, System.String>	parameterValues	Initial parameter values, where key is process parameter name and value is serialized parameter value.

Returns

Type	Description
ProcessDescriptor	Process description data.

Execute(Guid, IReadOnlyDictionary<String, String>, IEnumerable<String>)

Executes process with corresponding schema UId.

Declaration

ProcessDescriptor Execute(Guid processSchemaUId, IReadOnlyDictionary<string, string> parameterValues, IEnumerable<string> resultParameterNames)

Parameters

Type	Name	Description
System.Guid	processSchemaUId	UId of process schema.
System.Collections.Generic.IReadOnlyDictionary<System.String, System.String>	parameterValues	Initial parameter values, where key is process parameter name and value is serialized parameter value.
System.Collections.Generic.IEnumerable<System.String>	resultParameterNames	Result parameter names to read.

Returns

Type	Description
ProcessDescriptor	Process description data.

Execute(String)

Executes process with corresponding schema name.

Declaration

ProcessDescriptor Execute(string processSchemaName)

Parameters

Type	Name	Description
System.String	processSchemaName	Name of process schema.

Returns

Type	Description
ProcessDescriptor	Process description data.

Execute(String, IEnumerable<String>)

Executes process with corresponding schema name.

Declaration

ProcessDescriptor Execute(string processSchemaName, IEnumerable<string> resultParameterNames)

Parameters

Type	Name	Description
System.String	processSchemaName	Name of process schema.
System.Collections.Generic.IEnumerable<System.String>	resultParameterNames	Result parameter names to read.

Returns

Type	Description
ProcessDescriptor	Process description data.

Execute(String, IReadOnlyDictionary<String, String>)

Executes process with corresponding schema name.

Declaration

ProcessDescriptor Execute(string processSchemaName, IReadOnlyDictionary<string, string> parameterValues)

Parameters

Type	Name	Description
System.String	processSchemaName	Name of process schema.
System.Collections.Generic.IReadOnlyDictionary<System.String, System.String>	parameterValues	Initial parameter values, where key is process parameter name and value is serialized parameter value.

Returns

Type	Description
ProcessDescriptor	Process description data.

Execute(String, IReadOnlyDictionary<String, String>, IEnumerable<String>)

Executes process with corresponding schema name.

Declaration

ProcessDescriptor Execute(string processSchemaName, IReadOnlyDictionary<string, string> parameterValues, IEnumerable<string> resultParameterNames)

Parameters

Type	Name	Description
System.String	processSchemaName	Name of process schema.
System.Collections.Generic.IReadOnlyDictionary<System.String, System.String>	parameterValues	Initial parameter values, where key is process parameter name and value is serialized parameter value.
System.Collections.Generic.IEnumerable<System.String>	resultParameterNames	Result parameter names to read.

Returns

Type	Description
ProcessDescriptor

Execute<TResult>(Guid, String)

Executes process with corresponding schema UId and returns process parameter value.

Declaration

TResult Execute<TResult>(Guid processSchemaUId, string resultParameterName)

Parameters

Type	Name	Description
System.Guid	processSchemaUId	UId of process schema.
System.String	resultParameterName	Name of parameter to read result from.

Returns

Type	Description
TResult	Result parameter value.

Type Parameters

Name	Description
TResult	Result parameter value type.

Execute<TResult>(Guid, String, IReadOnlyDictionary<String, String>)

Executes process with corresponding schema UId and returns process parameter value.

Declaration

TResult Execute<TResult>(Guid processSchemaUId, string resultParameterName, IReadOnlyDictionary<string, string> parameterValues)

Parameters

Type	Name	Description
System.Guid	processSchemaUId	UId of process schema.
System.String	resultParameterName	Name of parameter to read result from.
System.Collections.Generic.IReadOnlyDictionary<System.String, System.String>	parameterValues	Initial parameter values. Where Key is process parameter name and value is serialized parameter value.

Returns

Type	Description
TResult	Result parameter value.

Type Parameters

Name	Description
TResult	Result parameter value type.

Execute<TResult>(String, String)

Executes process with corresponding schema name and returns process parameter value.

Declaration

TResult Execute<TResult>(string processSchemaName, string resultParameterName)

Parameters

Type	Name	Description
System.String	processSchemaName	Name of process schema.
System.String	resultParameterName	Name of parameter to read result from.

Returns

Type	Description
TResult	Result parameter value.

Type Parameters

Name	Description
TResult	Result parameter value type.

Execute<TResult>(String, String, IReadOnlyDictionary<String, String>)

Executes process with corresponding schema name and returns process parameter value.

Declaration

TResult Execute<TResult>(string processSchemaName, string resultParameterName, IReadOnlyDictionary<string, string> parameterValues)

Parameters

Type	Name	Description
System.String	processSchemaName	Name of process schema.
System.String	resultParameterName	Name of parameter to read result from.
System.Collections.Generic.IReadOnlyDictionary<System.String, System.String>	parameterValues	Initial parameter values, where key is process parameter name and value is serialized parameter value.

Returns

Type	Description
TResult	Result parameter value.

Type Parameters

Name	Description
TResult	Result parameter value type.

ExecuteByCaption(String)

Executes process with corresponding schema caption.

Declaration

ProcessDescriptor ExecuteByCaption(string processSchemaCaption)

Parameters

Type	Name	Description
System.String	processSchemaCaption	Caption of process schema.

Returns

Type	Description
ProcessDescriptor	Process description data.

ExecuteByCaption(String, IReadOnlyDictionary<String, String>)

Executes process with corresponding schema caption.

Declaration

ProcessDescriptor ExecuteByCaption(string processSchemaCaption, IReadOnlyDictionary<string, string> parameterValues)

Parameters

Type	Name	Description
System.String	processSchemaCaption	Caption of process schema.
System.Collections.Generic.IReadOnlyDictionary<System.String, System.String>	parameterValues	Initial parameter values, where key is process parameter name and value is serialized parameter value.

Returns

Type	Description
ProcessDescriptor	Process description data.

ExecuteByCaption<TResult>(String, String)

Executes process with corresponding schema caption and returns process parameter value.

Declaration

TResult ExecuteByCaption<TResult>(string processSchemaCaption, string resultParameterName)

Parameters

Type	Name	Description
System.String	processSchemaCaption	Caption of process schema.
System.String	resultParameterName	Name of parameter to read result from.

Returns

Type	Description
TResult	Result parameter value.

Type Parameters

Name	Description
TResult	Result parameter value type.

ExecuteByCaption<TResult>(String, String, IReadOnlyDictionary<String, String>)

Executes process with corresponding schema caption and returns process parameter value.

Declaration

TResult ExecuteByCaption<TResult>(string processSchemaCaption, string resultParameterName, IReadOnlyDictionary<string, string> parameterValues)

Parameters

Type	Name	Description
System.String	processSchemaCaption	Caption of process schema.
System.String	resultParameterName	Name of parameter to read result from.
System.Collections.Generic.IReadOnlyDictionary<System.String, System.String>	parameterValues	Initial parameter values, where key is process parameter name and value is serialized parameter value.