Interface IQueryRunner

The system entity for a Query Runner, which allows each result of a query to be run against a QueryRunHandler

See https://web.lemonedge.com/help/query-runners/ for more information

Inherited Members
System.IEquatable<LemonEdge.API.Core.IBaseEntity>.Equals(LemonEdge.API.Core.IBaseEntity)
System.ComponentModel.INotifyPropertyChanged.PropertyChanged
System.ComponentModel.INotifyPropertyChanging.PropertyChanging
Namespace: LemonEdge.API.Entities
Assembly: API.dll
Syntax
[EntityDefinition(EntityID.QueryRunner, "dbo.LT_QueryRunners", "QueryRunner", LabelColumn = "Name", IsStandingDataEntity = false, HelpURL = "query-runners")]
[DefaultEntityIcon(ImageType.Broadcast)]
public interface IQueryRunner : IBaseEntityWithPermissions, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties, ISetCopier, IHasVersion, IUserSpecific

Properties

Base64SerializedQueryExecuter

An optional QueryableExecuter used to filter the SQLWrapperID or EntityTypeID result set

Declaration
[EntityProperty(SQLType.NVarChar, true)]
[EntityDescription("An optional QueryableExecuter used to filter the SQLWrapperID or EntityTypeID result set")]
string Base64SerializedQueryExecuter { get; set; }
Property Value
Type Description
System.String

Description

A user friendly description for this query runner

Declaration
[EntityProperty(SQLType.NVarChar, (short)2000, true)]
[EntityDescription("A user friendly description of this query runner.")]
string Description { get; set; }
Property Value
Type Description
System.String

DisableTestRuns

Indicates if this query runner can be run in test mode or not by the user

Declaration
[EntityProperty(SQLType.Bit, false, "0")]
[EntityDescription("Indicates if this query runner can be run in test mode or not by the user")]
bool DisableTestRuns { get; set; }
Property Value
Type Description
System.Boolean

EntityTypeID

The type of entity to use as results to call other QueryRunHandlers.

Declaration
[EntityProperty(SQLType.UniqueIdentifier, true, IsEntityTypeLink = true)]
[EntityDescription("The type of entity to use as results to call other QueryRunHandlers.")]
Guid? EntityTypeID { get; set; }
Property Value
Type Description
System.Nullable<System.Guid>

Name

[Key] The unique name for this query runner

Declaration
[EntityProperty(SQLType.NVarChar, (short)500, false)]
[EntityDescription("The unique name of this query runner.")]
[Required(AllowEmptyStrings = false)]
string Name { get; set; }
Property Value
Type Description
System.String

SQLWrapperID

The sql wrapper this query runner executes and uses the results of to call other QueryRunHandlers

Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityDescription("The sql wrapper this query runner executes and uses the results of to call other QueryRunHandlers.")]
[EntityRelationship(EntityID.SQLWrapper, "ID", SingleJoinType.ZeroToOne, "SQL Wrapper", "Query Runners", DeleteWithRelationship = false, PartOfParentSet = false, LinkToItemInSet = true, InheritPermissions = false)]
Guid? SQLWrapperID { get; set; }
Property Value
Type Description
System.Nullable<System.Guid>

Extension Methods