Class ExportCSVParameter

The server task parameters for the exporting data to csv server task process

This task exports data from either a ISQLWrapper data source, or from any entity ( EntityDescriptor) in the system

Inheritance
object
SerializedParam
ServerTaskParameter
ExportCSVParameter
Implements
Inherited Members
Namespace: LemonEdge.API.Core.Tasks.Parameters
Assembly: LemonEdge.API.dll
Syntax
[DataContract]
public class ExportCSVParameter : ServerTaskParameter, ICloneable, ICloneable<ExportCSVParameter>, INotifyPropertyChanged, IQueryExportParams

Constructors

ExportCSVParameter()

Declaration
public ExportCSVParameter()

Fields

UNIQUE_TASK_ID

The unique id of the exporting data to csv server task

Declaration
public const string UNIQUE_TASK_ID = "6314045e-6b89-461c-863a-d772ea59c928"
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

An IEnumerable of ColumnDescriptor holding a list of all the columns to return.

If null then all columns will be included in the csv export, otherwise only the ones here will be included which can drastically reduce the query time, file size and improve performance

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

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?

EntityTypeKey

The UniqueKey of any entity in the system to export data from

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

EntityTypeKey_Label

The name of any entity in the system to export data from

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

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

SQLWrapperID

The id of a ISQLWrapper that should be used to export data from into a csv file

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

SQLWrapperID_Label

The name of a ISQLWrapper that should be used to export data from into a csv file

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

Methods

Clone()

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

Declaration
public ExportCSVParameter Clone()
Returns
Type Description
ExportCSVParameter

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

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

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

Events

PropertyChanged

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
Type Description
PropertyChangedEventHandler

Implements

Extension Methods