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)
Inherited Members
Namespace: LemonEdge.API.Tasks.Results
Assembly: API.dll
Syntax
[DataContract]
public class ExecuteQueryRunnerResult : ServerTaskResult, ICloneable, ICloneable<ExecuteQueryRunnerResult>
Properties
DefaultFolderPath
The default path that files should be saved to
Declaration
public string DefaultFolderPath { get; }
Property Value
Type | Description |
---|---|
System.String |
HasFiles
Indicates the results have some generated files
Declaration
public bool HasFiles { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
QueryRunnerID
The id of the query runner these results were generated from
Declaration
public Guid QueryRunnerID { get; set; }
Property Value
Type | Description |
---|---|
System.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 |
---|---|
System.Int32 |
RunKey
The query runner run key these results were generated for
Declaration
public string RunKey { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Methods
AddFile(IQueryRunnerStep, Int32, 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 |
System.Int32 | resultRow | The row result of the main query runner that this file is being produced for |
System.String | fileName | The name of the file produced |
Clone()
Declaration
public ExecuteQueryRunnerResult Clone()
Returns
Type | Description |
---|---|
ExecuteQueryRunnerResult |
CopyFromParam(SerializedParam)
Declaration
protected override void CopyFromParam(SerializedParam source)
Parameters
Type | Name | Description |
---|---|---|
SerializedParam | source |
Overrides
CopyFromSource(ExecuteQueryRunnerResult)
Declaration
public void CopyFromSource(ExecuteQueryRunnerResult source)
Parameters
Type | Name | Description |
---|---|---|
ExecuteQueryRunnerResult | source |
CreateNewParam()
Declaration
protected override SerializedParam CreateNewParam()
Returns
Type | Description |
---|---|
SerializedParam |
Overrides
GetFileName(Guid, Int32)
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 |
---|---|---|
System.Guid | forStepID | The step to return the generated file name for |
System.Int32 | forResultRow | The row result to return the generated file name for |
Returns
Type | Description |
---|---|
System.String | The specified file name for the specifed step and row result. |