Interface IAlgorithm

The system entity for algorithms, which allow custom excel like algorithms to be configured

Inherited Members
Namespace: LemonEdge.API.Entities.Design
Assembly: LemonEdge.API.dll
Syntax
[EntityDefinition(EntityID.Algorithm, "dbo.LT_Algorithms", "Algorithm", LabelColumn = "Name", IsStandingDataEntity = true)]
[DefaultEntityIcon(ImageType.Algorithm)]
public interface IAlgorithm : IBaseEntityWithPermissions, ISetCopier, IHasFolderStructure, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties

Properties

AllowReruns

Indicates if an algorithm run is allowed to be re-run when it is complete

Declaration
[EntityProperty(SQLType.SmallInt, false, "0")]
[EntityDescription("Indicates if an algorithm run is allowed to be re-run when it is complete.")]
RerunState AllowReruns { get; set; }
Property Value
Type Description
RerunState

CodeSnippetID

Links to ICodeSnippet. An optional code snippet for processing additional complexity in an algorithm

Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.CodeSnippet, "ID", SingleJoinType.ZeroToOne, "Code Snippet", "Used In Algorithms", DeleteWithRelationship = false, PartOfParentSet = false, LinkToItemInSet = true, InheritPermissions = false)]
Guid? CodeSnippetID { get; set; }
Property Value
Type Description
Guid?

Description

A user friendly description of this algorithm

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

Name

[Key] A unique friendly name for this algorithm.

Declaration
[EntityProperty(SQLType.NVarChar, 500, false)]
[EntityKeyProperty]
[EntityDescription("The unique name of this Algorithm.")]
[Unique]
[Required]
string Name { get; set; }
Property Value
Type Description
string

QueryRunnerID

Links to IQueryRunner. The runner that has parameters and populates this algorithm

Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityRelationship(EntityID.QueryRunner, "ID", SingleJoinType.One, "Query Runner", "Used In Algorithms", DeleteWithRelationship = false, PartOfParentSet = false, LinkToItemInSet = true, InheritPermissions = false)]
[RequiredNoDefaultIDValidation]
Guid QueryRunnerID { get; set; }
Property Value
Type Description
Guid

RunType

Indicates how the system should run an algorithm, whether it stores the calculation, produces an output, or allows a choice

Declaration
[EntityProperty(SQLType.SmallInt, false, "0")]
[EntityDescription("Indicates how the system should run an algorithm, whether it stores the calculation, produces an output, or allows a choice.")]
AlgorithmRunState RunType { get; set; }
Property Value
Type Description
AlgorithmRunState

Extension Methods