Class EntityQueryRunnerHandler

Inheritance

object

EntityQueryRunnerHandler

Implements

IQueryRunnerHandler

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: LemonEdge.API.Core.Reporting.Queries

Assembly: LemonEdge.API.dll

Syntax

public class EntityQueryRunnerHandler : IQueryRunnerHandler

Constructors

EntityQueryRunnerHandler()

Declaration

public EntityQueryRunnerHandler()

Fields

KEY

Declaration

public const string KEY = "74113B4F-B6E5-4EB5-A460-AE119D64DFEE"

Field Value

Type	Description
string

Properties

CustomHandlerInstanceItems

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

Declaration

public 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

public string HandlerName { get; }

Property Value

Type	Description
string

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

public 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

public QueryRunnerHandlerInstanceType RequiresHandlerInstance { get; }

Property Value

Type	Description
QueryRunnerHandlerInstanceType

SettingsType

Declaration

public Type SettingsType { get; }

Property Value

Type	Description
Type

Methods

GetParam(IQueryRunnerStep)

Declaration

public 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

public 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

Implements

IQueryRunnerHandler

Extension Methods

LinqExtensions.AsArray<T>(T)

LinqExtensions.ToArrayOfOne<T>(T)

LinqExtensions.ToListOfOne<T>(T)

MiscExtensions.SetIfNotEqual<T, TP>(T, Expression<Func<T, TP>>, TP)

WeakReferenceExtensions.WeakReference(object)

SQLExtensions.ToSQLValue(object, bool)

ReflectionExtensions.ClearEventInvocations(object, string)

StringExtensions.ToCSVFormatString(object, Type)