Interface IQueryRunnerHandlerExecutor
An interface that can implement running a query handler against a IQueryRunnerStep in a IQueryRunner run
Inherited Members
Namespace: LemonEdge.API.Queries
Assembly: API.dll
Syntax
public interface IQueryRunnerHandlerExecutor : IDisposableProperties
QueryRunnerHandlerTypeID
The unique type of this handler. Should be the TypeID of the entity that can be used in a IQueryRunnerStep
Declaration
Guid QueryRunnerHandlerTypeID { get; }Property Value
| Type | Description |
|---|---|
| System.Guid |
Methods
ExecuteStep(String, Dictionary<String, Object>, Action<String>)
Executes this handler within a IQueryRunnerStep, and returns the generated file
Declaration
Task<(byte[] GeneratedReport, string FileType)> ExecuteStep(string fileNamePath, Dictionary<string, object> executeParams, Action<string> logMessage)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | fileNamePath | The name of the file to be generated |
| System.Collections.Generic.Dictionary<System.String, System.Object> | executeParams | A list of evaluated parameters and their values for this handler to use while executing |
| System.Action<System.String> | logMessage | An action for logging any message during the generation of the file |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.ValueTuple<System.Byte[], System.String>> | The generated file |
Init(QueryRunnerHandlerExecutorInfo, IEntityUpdater, IReadOnlyCache, UserInfo)
Initializes this executer for the specific run instance this is running within. Only called once.
Declaration
Task Init(QueryRunnerHandlerExecutorInfo info, IEntityUpdater updater, IReadOnlyCache cache, UserInfo userInfo)Parameters
| Type | Name | Description |
|---|---|---|
| QueryRunnerHandlerExecutorInfo | info | Information of the run instance this executer is running within |
| IEntityUpdater | updater | A context for querying the database |
| IReadOnlyCache | cache | A local cache |
| UserInfo | userInfo | The current user this is operating under |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | A task indicating the completion of the operation |