[DataContract]
[ServerTaskParameters("Execute Query Runner", "fb74e5a0-eeab-4ae5-bcde-341e75f06534", Description = "Executes the query runner, and for each result executes each query runner step and stores the generated files(s).")]
public class ExecuteQueryRunnerParameter : ItemParameter, ICloneable, ICloneable<ExecuteQueryRunnerParameter>, INotifyPropertyChanged, IQueryExportParams

Constructors

ExecuteQueryRunnerParameter()

Declaration

public ExecuteQueryRunnerParameter()

Fields

UNIQUE_TASK_ID

The unique id of the query runner executer server task

Declaration

public const string UNIQUE_TASK_ID = "fb74e5a0-eeab-4ae5-bcde-341e75f06534"

Field Value

Type	Description
string

Properties

AsOfDate

An as of date that this query should run as of, when producing the data to export to csv

Declaration

public DateTimeOffset? AsOfDate { get; set; }

Property Value

Type	Description
DateTimeOffset?

Base64SerializedColumnsToReturn

Not used - only for IQueryExportParams compatability

Declaration

public string Base64SerializedColumnsToReturn { get; set; }

Property Value

Type	Description
string

Base64SerializedFormulaParameters

If executing a ISQLWrapper to retrieve data to write to a csv file, then this holds a Dictionary of string, string holding formulas for values

Declaration

public string Base64SerializedFormulaParameters { get; set; }

Property Value

Type	Description
string

Base64SerializedGlobalParameters

Holds the global parameters for the query runner

Declaration

public string Base64SerializedGlobalParameters { get; set; }

Property Value

Type	Description
string

Base64SerializedParameters

If executing a ISQLWrapper to retrieve data to write to a csv file, then this holds a Dictionary of string, string holding parameter names, and values for executing the specified custom query

Declaration

public string Base64SerializedParameters { get; set; }

Property Value

Type	Description
string

Base64SerializedQueryExecuter

A QueryableExecuter either of the type of the entity for EntityTypeKey, or of a ISQLWrapperResult used to apply further filtering dynamically to the result set that should be exported to csv

Declaration

public string Base64SerializedQueryExecuter { get; set; }

Property Value

Type	Description
string

CanvasID

The id of a canvas that this query should run within when producing the data to export to csv

Declaration

public Guid? CanvasID { get; set; }

Property Value

Type	Description
Guid?

HasExcelHandler

Indicates the client handling this csv file will open it straight into excel and thus this csv file should have two header rows, one for the named data range, and the other a user friendly header

If this is false the csv will just have one header row which is the same as the excel named data range for importing the data back in, and so will lack the user friendly header

Declaration

public bool HasExcelHandler { get; set; }

Property Value

Type	Description
bool

IncludeRowCount

Indicates the system should run the query once to get the total count, and another time to process the import providing a percentage progression

For improved performance the query will run without a row count but then the task can not provide feedback on the progress of the task

Declaration

public bool IncludeRowCount { get; set; }

Property Value

Type	Description
bool

QueryRunnerID

The id of a IQueryRunner that should be used to execute

Declaration

public Guid QueryRunnerID { get; set; }

Property Value

Type	Description
Guid

QueryRunnerID_Label

The name of a IQueryRunner that should be used to execute

Declaration

public string QueryRunnerID_Label { 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

ServerTaskMode

Declaration

public bool ServerTaskMode { get; set; }

Property Value

Type	Description
bool

Methods

Clone()

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

Declaration

public ExecuteQueryRunnerParameter Clone()

Returns

Type	Description
ExecuteQueryRunnerParameter	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

ItemParameter.CopyFromParam(SerializedParam)

Remarks

Used by the generic implementation of Clone()

CopyFromSource(ExecuteQueryRunnerParameter)

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

Declaration

public void CopyFromSource(ExecuteQueryRunnerParameter source)

Parameters

Type	Name	Description
ExecuteQueryRunnerParameter	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

SerializedParam.CreateNewParam()

GetUserFriendlyTaskInstanceIdentityInfo(IServerTask)

Returns that this is a export data to csv task against the specified ISQLWrapper or entity

Declaration

public override string GetUserFriendlyTaskInstanceIdentityInfo(IServerTask task)

Parameters

Type	Name	Description
IServerTask	task	The server task for processing the export data to csv task

Returns

Type	Description
string	A string stating that this is a export data to csv task against the specified ISQLWrapper or entity

Overrides

ServerTaskParameter.GetUserFriendlyTaskInstanceIdentityInfo(IServerTask)

Events

PropertyChanged

Declaration

public event PropertyChangedEventHandler PropertyChanged

Event Type

Type	Description
PropertyChangedEventHandler

Implements

ICloneable

ICloneable<T>

INotifyPropertyChanged

IQueryExportParams

Extension Methods

LinqExtensions.AsArray<T>(T)

LinqExtensions.ToArrayOfOne<T>(T)

LinqExtensions.ToListOfOne<T>(T)

MiscExtensions.SetIfNotEqual<T, TP>(T, Expression<Func<T, TP>>, TP)

WeakReferenceExtensions.WeakReference(object)

SQLExtensions.ToSQLValue(object, bool)

ReflectionExtensions.ClearEventInvocations(object, string)

StringExtensions.ToCSVFormatString(object, Type)