Interface IQueryRunnerHandlerExecutor

An interface that can implement running a query handler against a IQueryRunnerStep in a IQueryRunner run

Inherited Members
Namespace: LemonEdge.API.Core.Reporting.Queries
Assembly: LemonEdge.API.dll
Syntax
public interface IQueryRunnerHandlerExecutor : IDisposable

Properties

CanExecuteMultipleResultsAtOnce

Declaration
bool CanExecuteMultipleResultsAtOnce { get; }
Property Value
Type Description
bool

DefaultResultsToProcessAtOnce

Declaration
int? DefaultResultsToProcessAtOnce { get; }
Property Value
Type Description
int?

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
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
string fileNamePath

The name of the file to be generated
Dictionary<string, object> executeParams

A list of evaluated parameters and their values for this handler to use while executing
Action<string> logMessage

An action for logging any message during the generation of the file
Returns
Type Description
Task<(byte[] GeneratedReport, string FileType)>

The generated file

ExecuteStepWithMultipleResults(List<Dictionary<string, object>>, Action<string>)

Declaration
Task<IEnumerable<(byte[] GeneratedReport, string FileType)>> ExecuteStepWithMultipleResults(List<Dictionary<string, object>> executeParams, Action<string> logMessage)
Parameters
Type Name Description
List<Dictionary<string, object>> executeParams
Action<string> logMessage
Returns
Type Description
Task<IEnumerable<(byte[] GeneratedReport, string FileType)>>

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
Task

A task indicating the completion of the operation

Extension Methods