Interface IAlgorithmRun

The system entity for algorithm runs, which allow custom excel like algorithms to be run to produce outputs in the system

Inherited Members
Namespace: LemonEdge.API.Entities.Design
Assembly: LemonEdge.API.dll
Syntax
[EntityDefinition(EntityID.AlgorithmRun, "dbo.LT_AlgorithmRuns", "AlgorithmRun", LabelColumn = "Name")]
[DefaultEntityIcon(ImageType.AlgorithmRun)]
[EntityIndex(Name = "AlgorithmRun", ColumnNames = new string[] { "AlgorithmID" }, IndexOrder = new IndexOrder[] { IndexOrder.Ascending }, IsClustered = false, IsUnique = false)]
public interface IAlgorithmRun : IBaseEntityWithPermissions, IHasSaveProcessingTask, IHasFolderStructure, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties

Properties

AlgorithmID

Links to IAlgorithm this run is using

Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityRelationship(EntityID.Algorithm, "ID", SingleJoinType.One, "Algorithm", "Runs", DeleteWithRelationship = true, PartOfParentSet = false, LinkToItemInSet = false, InheritPermissions = false)]
[RequiredNoDefaultIDValidation]
Guid AlgorithmID { get; set; }
Property Value
Type Description
Guid

Description

A user friendly description of this algorithm run

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

Name

An optional friendly name for this algorithm run.

Declaration
[EntityProperty(SQLType.NVarChar, 500, false)]
[EntityDescription("An optional friendly name for this algorithm run.")]
string Name { get; set; }
Property Value
Type Description
string

Reference

The auto-increment unique reference for this algorithm run

Declaration
[EntityProperty(SQLType.Int, false)]
[EntityDescription("The auto-increment unique reference for this algorithm run.")]
[EntityKeyProperty]
[EntityAutoIncrementColumn(1)]
int Reference { get; set; }
Property Value
Type Description
int

RunSource

Indicates how this algorithm was initiated. If from a ReprocessingOriginal, then the original algorithm ID can be passed to the algorithim using an @OriginalAlgorithmID parameter.

If run from a stepchange then a parameter of @stepRunDate will automatically be updated to contain the step change date, and @stepTransactionDate will automatically be updated to contain the step transaction date, instead of the original date when being re-run

Declaration
[EntityProperty(SQLType.SmallInt, false, "0")]
[EntityDescription("Indicates how this algorithm was initiated. If run from a stepchange then a parameter of @stepRunDate will automatically be updated to contain the step change date, and @stepTransactionDate will automatically be updated to contain the step transaction date, instead of the original date when being re-run.")]
AlgorithmRunSource RunSource { get; set; }
Property Value
Type Description
AlgorithmRunSource

RunType

Indicates how this algorithm run should be processed

Declaration
[EntityProperty(SQLType.SmallInt, false, "0")]
[EntityDescription("Indicates how this algorithm run should be processed.")]
AlgorithmRunState RunType { get; set; }
Property Value
Type Description
AlgorithmRunState

Status

Indicates if this algorithm run should be processed or not, and if it is complete

Declaration
[EntityProperty(SQLType.SmallInt, false)]
[EntityDescription("Indicates if this algorithm run should be processed or not, and if it is complete.")]
AlgorithmRunStatus Status { get; set; }
Property Value
Type Description
AlgorithmRunStatus

Extension Methods