[DataContract]
public class AlgorithmRun : BaseEntityWithPermissions, IAlgorithmRun, IBaseEntityWithPermissions, IHasSaveProcessingTask, IHasFolderStructure, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties, ICloneableAsync<IAlgorithmRun>

Constructors

AlgorithmRun()

Declaration

public AlgorithmRun()

Properties

AlgorithmID

Links to IAlgorithm this run is using

Declaration

[RequiredNoDefaultIDValidation]
public Guid AlgorithmID { get; set; }

Property Value

Type	Description
Guid

AlgorithmID_Label

Declaration

public string AlgorithmID_Label { get; set; }

Property Value

Type	Description
string

AlgorithmID_Label_Silent

Declaration

[NotMapped]
public string AlgorithmID_Label_Silent { get; set; }

Property Value

Type	Description
string

Description

A user friendly description of this algorithm run

Declaration

[StringLength(2000)]
public string Description { get; set; }

Property Value

Type	Description
string

FolderID

The link to the folder this item is contained in

Declaration

public Guid? FolderID { get; set; }

Property Value

Type	Description
Guid?

FolderID_Label

Declaration

public string FolderID_Label { get; set; }

Property Value

Type	Description
string

FolderID_Label_Silent

Declaration

[NotMapped]
public string FolderID_Label_Silent { get; set; }

Property Value

Type	Description
string

Name

An optional friendly name for this algorithm run.

Declaration

[StringLength(500)]
public string Name { get; set; }

Property Value

Type	Description
string

PriorRunTaskParam

Holds the task parameters used when this was previously run. SavedTaskParam is cleared after processing to distinguish between imports and other operations.

Declaration

public byte[] PriorRunTaskParam { get; set; }

Property Value

Type	Description
byte[]

Reference

The auto-increment unique reference for this algorithm run

Declaration

public 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

[EnumDataType(typeof(AlgorithmRunSource))]
public AlgorithmRunSource RunSource { get; set; }

Property Value

Type	Description
AlgorithmRunSource

Declaration

[NotMapped]
public string RunSource_Tooltip { get; set; }

Property Value

Type	Description
string

RunType

Indicates how this algorithm run should be processed

Declaration

[EnumDataType(typeof(AlgorithmRunState))]
public AlgorithmRunState RunType { get; set; }

Property Value

Type	Description
AlgorithmRunState

Declaration

[NotMapped]
public string RunType_Tooltip { get; set; }

Property Value

Type	Description
string

SavedTaskID

Links to IServerTask. Indicates the task that has been automatically created during the save process for completing any further processing

Declaration

public Guid? SavedTaskID { get; set; }

Property Value

Type	Description
Guid?

SavedTaskID_Label

Declaration

public string SavedTaskID_Label { get; set; }

Property Value

Type	Description
string

SavedTaskID_Label_Silent

Declaration

[NotMapped]
public string SavedTaskID_Label_Silent { get; set; }

Property Value

Type	Description
string

SavedTaskParam

Holds the associated parameters for the task SavedTaskID

Declaration

public byte[] SavedTaskParam { get; set; }

Property Value

Type	Description
byte[]

Status

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

Declaration

[EnumDataType(typeof(AlgorithmRunStatus))]
public AlgorithmRunStatus Status { get; set; }

Property Value

Type	Description
AlgorithmRunStatus

Declaration

[NotMapped]
public string Status_Tooltip { get; set; }

Property Value

Type	Description
string

Methods

CopyFromEntity(IBaseEntity)

Declaration

protected override void CopyFromEntity(IBaseEntity src)

Parameters

Type	Name	Description
IBaseEntity	src

Overrides

BaseEntity.CopyFromEntity(IBaseEntity)

CopyFromSource(IAlgorithmRun)

Updates all properties in this item to have the same properties as the source object.

Declaration

public void CopyFromSource(IAlgorithmRun source)

Parameters

Type	Name	Description
IAlgorithmRun	source	The source object to copy all values from.

GetShouldAutoGenerateTaskOnSave()

Indicates if the task should automatically be generated on save

Only runs on the service, or directly connected to db. Defaults to true

So ensure processors that implement IBaseDataSetProcessorWithDBSave correctly set this for the task to be auto created or not on save

Declaration

public bool GetShouldAutoGenerateTaskOnSave()

Returns

Type	Description
bool	If the task should automatically be generated on save

SetAutoGenerateOnSave(bool)

Sets if thie task should be generated for this item on save or not

Declaration

public void SetAutoGenerateOnSave(bool value)

Parameters

Type	Name	Description
bool	value	Indicates if the task should be generated on save or not

ToString()

Declaration

public override string ToString()

Returns

Type	Description
string