Class ExecuteQueryRunnerResult

An execute query runner task result returned by the IServerTask. Holds the filename that was generated by executing the IQueryRunnerStep executions ( UNIQUE_TASK_ID)

Inheritance
object
SerializedParam
ServerTaskResult
ExecuteQueryRunnerResult
Implements
Inherited Members
Namespace: LemonEdge.API.Core.Tasks.Results
Assembly: LemonEdge.API.dll
Syntax
[DataContract]
public class ExecuteQueryRunnerResult : ServerTaskResult, ICloneable, ICloneable<ExecuteQueryRunnerResult>

Constructors

ExecuteQueryRunnerResult()

Declaration
public ExecuteQueryRunnerResult()

Properties

DefaultFolderPath

The default path that files should be saved to

Declaration
public string DefaultFolderPath { get; }
Property Value
Type Description
string

HasFiles

Indicates the results have some generated files

Declaration
public bool HasFiles { get; }
Property Value
Type Description
bool

QueryRunnerID

The id of the query runner these results were generated from

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

ResultCount

The total number of rows returned from the results of executing the query runner, representing the number of files generated for each step in the runner.

Declaration
public int ResultCount { get; set; }
Property Value
Type Description
int

RunKey

The query runner run key these results were generated for

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

Methods

AddFile(IQueryRunnerStep, int, string)

Adds the specified file name to the list of files produced by this query runner for the specified step

Declaration
public void AddFile(IQueryRunnerStep forStep, int resultRow, string fileName)
Parameters
Type Name Description
IQueryRunnerStep forStep

The step this file is produced for
int resultRow

The row result of the main query runner that this file is being produced for
string fileName

The name of the file produced

Clone()

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

Declaration
public ExecuteQueryRunnerResult Clone()
Returns
Type Description
ExecuteQueryRunnerResult

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(ExecuteQueryRunnerResult)

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

Declaration
public void CopyFromSource(ExecuteQueryRunnerResult source)
Parameters
Type Name Description
ExecuteQueryRunnerResult 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

GetFileName(Guid, int)

Retrieves the specified file name for the specifed step and row result.

Using ResultCount, you can enumerate this calling it from 1 - ResultCount to get all generated files for a step (in order)

Declaration
public string GetFileName(Guid forStepID, int forResultRow)
Parameters
Type Name Description
Guid forStepID

The step to return the generated file name for
int forResultRow

The row result to return the generated file name for
Returns
Type Description
string

The specified file name for the specifed step and row result.

Implements

Extension Methods