Class AlgorithmRunParameter

Inheritance
object
SerializedParam
ServerTaskParameter
ItemParameter
AlgorithmRunParameter
Implements
Inherited Members
Namespace: LemonEdge.API.Core.Tasks.Parameters
Assembly: LemonEdge.API.dll
Syntax
[DataContract]
[ServerTaskParameters("Run Algorithm", "A8D908A5-83D2-471F-BADB-D33669051464", Description = "Executes the specifed algorithm.", DefaultForHasSaveProcessingTask = typeof(IAlgorithmRun))]
public class AlgorithmRunParameter : ItemParameter, ICloneable, INotifyPropertyChanged, ICloneable<AlgorithmRunParameter>

Constructors

AlgorithmRunParameter()

Declaration
public AlgorithmRunParameter()

AlgorithmRunParameter(IAlgorithmRun)

Declaration
public AlgorithmRunParameter(IAlgorithmRun run)
Parameters
Type Name Description
IAlgorithmRun run

Fields

UNIQUE_TASK_ID

The unique id of the algorithm run calculation server task

Declaration
public const string UNIQUE_TASK_ID = "A8D908A5-83D2-471F-BADB-D33669051464"
Field Value
Type Description
string

Properties

AlgorithmID

Declaration
public Guid? AlgorithmID { get; set; }
Property Value
Type Description
Guid?

AlgorithmID_Label

Declaration
public string AlgorithmID_Label { get; set; }
Property Value
Type Description
string

QueryRunnerQueryParams

Declaration
public string QueryRunnerQueryParams { get; set; }
Property Value
Type Description
string

RunAsTest

Indicates the query runner should be run as a test only reporting the step names generated and not executing the handlers

Declaration
public bool RunAsTest { get; set; }
Property Value
Type Description
bool

Methods

Clone()

Creates a new instance of this class (of type AlgorithmRunParameter) with all the same property values as this instance

Declaration
public AlgorithmRunParameter Clone()
Returns
Type Description
AlgorithmRunParameter

A new instance of this class with all the same property values as this instance

CopyFromParam(SerializedParam)

Should be overridden by inheriting implementations to ensure all parameters values are copied from the specified source

Declaration
protected override void CopyFromParam(SerializedParam source)
Parameters
Type Name Description
SerializedParam source

The source instance of a SerializedParam that is of the same type as this one to copy parameter values from
Overrides
Remarks

Used by the generic implementation of Clone()

CopyFromSource(AlgorithmRunParameter)

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

Declaration
public void CopyFromSource(AlgorithmRunParameter source)
Parameters
Type Name Description
AlgorithmRunParameter source

The source object to copy all values from.

CreateNewParam()

Must be implemented by inheriting classes to provide a new instance of the current class type.

Used when cloning this SerializedParam to create a new instance of the same type

Declaration
protected override SerializedParam CreateNewParam()
Returns
Type Description
SerializedParam

A new instance of the current SerializedParam type
Overrides

GetUserFriendlyTaskInstanceIdentityInfo(IServerTask)

Returns a user friendly string for the type of task being processed that these parameters work against

Declaration
public override string GetUserFriendlyTaskInstanceIdentityInfo(IServerTask task)
Parameters
Type Name Description
IServerTask task

An instance of a task that these parameters work for
Returns
Type Description
string

A user friendly string for the type of task being processed that these parameters work against
Overrides

ShouldAutomaticallyCreateTask(IHasSaveProcessingTask, IEntityUpdater)

Returns true if the specified item should automatically have a task created against it for processing when being saved

By default returns true unless if the item implements ICanBeLocked and is locked.

The behaviour can be overridden by this method, or by implementing the item implementation of GetShouldAutoGenerateTaskOnSave()
Declaration
public override bool ShouldAutomaticallyCreateTask(IHasSaveProcessingTask item, IEntityUpdater context)
Parameters
Type Name Description
IHasSaveProcessingTask item

The item that can have tasks automatically created against them to process changes when they are saved
IEntityUpdater context

The current context the item is being changed and saved within
Returns
Type Description
bool

True if the specified item should automatically have a task created against it for processing when being saved
Overrides

Implements

Extension Methods