Interface IAlgorithmOutput
The system entity for holding the outputs from an algorithm
Inherited Members
Namespace: LemonEdge.API.Entities.Design
Assembly: LemonEdge.API.dll
Syntax
[EntityDefinition(EntityID.AlgorithmOutput, "dbo.LT_AlgorithmOutputs", "AlgorithmOutput", IsStandingDataEntity = true)]
[DefaultEntityIcon(ImageType.Algorithm)]
[EntityIndex(Name = "AlgorithmOutput", ColumnNames = new string[] { "AlgorithmID" }, IndexOrder = new IndexOrder[] { IndexOrder.Ascending }, IsClustered = false, IsUnique = false)]
public interface IAlgorithmOutput : IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties
Properties
AlgorithmID
Links to parent IAlgorithm.
Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityRelationship(EntityID.Algorithm, "ID", SingleJoinType.One, "Algorithm", "Outputs", DeleteWithRelationship = true, PartOfParentSet = true, LinkToItemInSet = false, InheritPermissions = true)]
[RequiredNoDefaultIDValidation]
Guid AlgorithmID { get; set; }
Property Value
Type | Description |
---|---|
Guid |
Context
Indicates how the import lines will be processed. Isolated - The context is new and only exists for this import output. Shared - the context is shared across multiple outputs so saves aren't committed untill the end.
Declaration
[EntityProperty(SQLType.SmallInt, false, "0")]
[EntityDescription("Indicates how the import lines will be processed. Isolated - The context is new and only exists for this import output. Shared - the context is shared across multiple outputs so saves aren't committed untill the end.")]
[Required]
ImportDefinitionStepContext Context { get; set; }
Property Value
Type | Description |
---|---|
ImportDefinitionStepContext |
DataMapperID
Links to a IDataMapping where headers are false and the column order is used.
Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityDescription("Links to a DataMapping where headers are false and the column order is used")]
[EntityRelationship(EntityID.DataMapping, "ID", SingleJoinType.One, "Data Mapping", "Used In Algorithm Outputs", DeleteWithRelationship = true, PartOfParentSet = false, LinkToItemInSet = true, InheritPermissions = false)]
[RequiredNoDefaultIDValidation]
Guid DataMapperID { get; set; }
Property Value
Type | Description |
---|---|
Guid |
NumberOfRows
Indicates the system will continute to process rows from the OutputStartCell for this specified amount of rows. If null it will continute until the data for the next row is empty
Declaration
[EntityProperty(SQLType.SmallInt, true)]
[EntityDescription(" Indicates the system will continute to process rows from the OutputStartCell for this specified amount of rows. If null it will continute until the data for the next row is empty")]
short? NumberOfRows { get; set; }
Property Value
Type | Description |
---|---|
short? |
Sequence
[Key] Holds the order of this output within the algorithm run.
Declaration
[EntityProperty(SQLType.SmallInt, false, "1")]
[EntityDescription("Holds the order of this output within the algorithm run.")]
[EntitySequence]
[EntityKeyProperty]
short Sequence { get; set; }
Property Value
Type | Description |
---|---|
short |
StartCell
Holds the cell to start processing the output of the algorithm from. Of the format Sheet!CellRef
Declaration
[EntityProperty(SQLType.NVarChar, 250, false)]
[EntityDescription("Holds the cell to start processing the output of the algorithm from. Of the format Sheet!CellRef")]
[Required]
string StartCell { get; set; }
Property Value
Type | Description |
---|---|
string |