[DataContract]
public class QueryRunnerStep : BaseEntity, IQueryRunnerStep, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties, ICloneableAsync<IQueryRunnerStep>, ISetCopierCustomChildren, ISetCopierCloneAlterer

Constructors

QueryRunnerStep()

Declaration

public QueryRunnerStep()

Properties

CopierCloneType

Declaration

public SetCopierCloneType CopierCloneType { get; set; }

Property Value

Type	Description
SetCopierCloneType

Description

A user friendly description for this query runner step

Declaration

[StringLength(2000)]
public string Description { get; set; }

Property Value

Type	Description
string

DocumentGeneratedStep

Write generated step as document

Declaration

[EnumDataType(typeof(QueryRunnerStepDocument))]
public QueryRunnerStepDocument DocumentGeneratedStep { get; set; }

Property Value

Type	Description
QueryRunnerStepDocument

Declaration

[NotMapped]
public string DocumentGeneratedStep_Tooltip { get; set; }

Property Value

Type	Description
string

DocumentType

The type of entity to save the document against

Declaration

public Guid? DocumentType { get; set; }

Property Value

Type	Description
Guid?

DocumentTypeIDFormula

A formula holding the id of the item to save the generated document against

Declaration

public string DocumentTypeIDFormula { get; set; }

Property Value

Type	Description
string

GeneratedStepNameFormula

A formula holding the name to be used for the result of executing this step against the current result of the query runner sql wrapper

Declaration

public string GeneratedStepNameFormula { get; set; }

Property Value

Type	Description
string

Index

The order this step will be processed in by the Query Runner. This can be moved up and down using the standard grid commands.

Declaration

public short Index { get; set; }

Property Value

Type	Description
short

Name

The name for this query runner step

Declaration

[Required(AllowEmptyStrings = false)]
[StringLength(500)]
public string Name { get; set; }

Property Value

Type	Description
string

ParentQueryRunnerID

The parent query runner this step belongs to

Declaration

[Required]
public Guid ParentQueryRunnerID { get; set; }

Property Value

Type	Description
Guid

ParentQueryRunnerID_Label

Declaration

public string ParentQueryRunnerID_Label { get; set; }

Property Value

Type	Description
string

ParentQueryRunnerID_Label_Silent

Declaration

[NotMapped]
public string ParentQueryRunnerID_Label_Silent { get; set; }

Property Value

Type	Description
string

RunnerHandlerID

The ID of the QueryRunnerHandler to use

Declaration

[Required]
public Guid? RunnerHandlerID { get; set; }

Property Value

Type	Description
Guid?

RunnerHandlerID_Label

Declaration

[NotMapped]
public string RunnerHandlerID_Label { get; set; }

Property Value

Type	Description
string

RunnerHandlerSettings

Optional settings for the runner handler

Declaration

public string RunnerHandlerSettings { get; set; }

Property Value

Type	Description
string

RunnerHandlerTypeID

The type of QueryRunnerHandler

Declaration

[Required]
public Guid RunnerHandlerTypeID { get; set; }

Property Value

Type	Description
Guid

StepGuardFormula

A formula that returns true to indicate if this step should be executed. If no formula the step by default will always be executed.

Declaration

public string StepGuardFormula { get; set; }

Property Value

Type	Description
string

StorageBasePath

Optional: the base path of the storage location to write to.

Declaration

public string StorageBasePath { get; set; }

Property Value

Type	Description
string

StorageConnectionString

Optional: the connection string, including credentials, of the storage device to connect to.

Declaration

public string StorageConnectionString { get; set; }

Property Value

Type	Description
string

StorageFilename

Optional: the filename by which the data will be saved in storage. If blank and set to store the Generated Step Name will be used.

Declaration

public string StorageFilename { get; set; }

Property Value

Type	Description
string

StorageType

Optional: the type of storage to write to.

Declaration

public string StorageType { get; set; }

Property Value

Type	Description
string

StoreDocumentStep

Write generated step to the storage location defined in the step parameters.

Declaration

[EnumDataType(typeof(QueryRunnerStepStorage))]
public QueryRunnerStepStorage StoreDocumentStep { get; set; }

Property Value

Type	Description
QueryRunnerStepStorage

Declaration

[NotMapped]
public string StoreDocumentStep_Tooltip { get; set; }

Property Value

Type	Description
string

Methods

AlterCopiedItem(IEntityUpdater, UserInfo, IReadOnlyCache, IBaseEntity)

A custom ability to alter this item when it is was copied by the user in the UI, not when it is being imported

Declaration

public Task AlterCopiedItem(IEntityUpdater host, UserInfo user, IReadOnlyCache cache, IBaseEntity sourceItem)

Parameters

Type	Name	Description
IEntityUpdater	host	The context this item was copied into
UserInfo	user	The current user
IReadOnlyCache	cache	The current local cache
IBaseEntity	sourceItem	The original source item this item was copied from

Returns

Type	Description
Task	A task inidicating the finishing of this method

CopyFromEntity(IBaseEntity)

Declaration

protected override void CopyFromEntity(IBaseEntity src)

Parameters

Type	Name	Description
IBaseEntity	src

Overrides

BaseEntity.CopyFromEntity(IBaseEntity)

CopyFromSource(IQueryRunnerStep)

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

Declaration

public void CopyFromSource(IQueryRunnerStep source)

Parameters

Type	Name	Description
IQueryRunnerStep	source	The source object to copy all values from.

GetCustomChildItem(IEntityRetriever, string)

Declaration

public Task<IBaseEntity> GetCustomChildItem(IEntityRetriever context, string propertyName)

Parameters

Type	Name	Description
IEntityRetriever	context
string	propertyName

Returns

Type	Description
Task<IBaseEntity>

GetCustomChildPropertyNames()

Declaration

public IEnumerable<string> GetCustomChildPropertyNames()

Returns

Type	Description
IEnumerable<string>

HasCustomChild(string)

Declaration

public bool HasCustomChild(string propertyName)

Parameters

Type	Name	Description
string	propertyName

Returns

Type	Description
bool

ToString()

Declaration

public override string ToString()

Returns

Type	Description
string