Interface IQueryRunnerHandler

An interface for an entity type that can be used as a RunnerHandlerID in a IQueryRunner

Namespace: LemonEdge.API.Core.Reporting.Queries
Assembly: LemonEdge.API.dll
Syntax
public interface IQueryRunnerHandler

Properties

CustomHandlerInstanceItems

A list of custom instances that can be used by this handler

Declaration
IEnumerable<KeyValuePair<Guid, string>> CustomHandlerInstanceItems { get; }
Property Value
Type Description
IEnumerable<KeyValuePair<Guid, string>>

HandlerName

The user friendly name for this type of query runner handler

Declaration
string HandlerName { get; }
Property Value
Type Description
string

IncludeAllSQLRowResultsAsParamValues

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

QueryRunnerHandlerTypeID

The unique type of this handler. Can be a TypeID of the entity that can be used in a IQueryRunnerStep, or a unique id if no instance is required

Declaration
Guid QueryRunnerHandlerTypeID { get; }
Property Value
Type Description
Guid

RequiresHandlerInstance

Indicates the type of instance required for use by this handler.

None indicates none, Entity indicates an instance of an entity of type QueryRunnerHandlerTypeID, and custom indicates an instance from CustomHandlerInstanceItems

Declaration
QueryRunnerHandlerInstanceType RequiresHandlerInstance { get; }
Property Value
Type Description
QueryRunnerHandlerInstanceType

SettingsType

Declaration
Type SettingsType { get; }
Property Value
Type Description
Type

Methods

GetParam(IQueryRunnerStep)

Declaration
SerializedParam GetParam(IQueryRunnerStep step)
Parameters
Type Name Description
IQueryRunnerStep step
Returns
Type Description
SerializedParam

GetParameters(Guid?, UserInfo, IReadOnlyCache, IEntityUpdater)

Returns a list of all the parameters configured against a specific instance of the handler type

For instance if this is a handler for ISQLWrapper, it would return all the parameters for the sql wrapper

Declaration
Task<IEnumerable<ISQLTypeWrapper>> GetParameters(Guid? forHandlerID, UserInfo user, IReadOnlyCache cache, IEntityUpdater updater)
Parameters
Type Name Description
Guid? forHandlerID

The instance of the entity id that is a handler for a IQueryRunnerStep
UserInfo user

The logged in user this is running for
IReadOnlyCache cache

A local cache
IEntityUpdater updater
Returns
Type Description
Task<IEnumerable<ISQLTypeWrapper>>

A list of all the parameters configured against a specific instance of the handler type

Extension Methods