Interface IQueryRunnerStepParameter
The system entity for a Query Runner Step Parameter, which provides the parameter value for the IQueryRunnerStep
See https://web.lemonedge.com/help/query-runners/ for more information
Inherited Members
Namespace: LemonEdge.API.Entities
Assembly: API.dll
Syntax
[EntityDefinition(EntityID.QueryRunnerStepParameter, "dbo.LT_QueryRunnerStepParamaters", "QueryRunnerStepParameter", IsStandingDataEntity = false)]
[DefaultEntityIcon(ImageType.DataTableColumn)]
public interface IQueryRunnerStepParameter : IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties
Properties
ParameterDefaultValue
This indicates a constant default value to provide as the value for the parameter for this runner step
Declaration
[EntityProperty(SQLType.NVarChar, (short)500, true, FriendlyLabel = "Default Value")]
[EntityDescription("This indicates a constant default value to provide as the value for the parameter for this runner step.")]
string ParameterDefaultValue { get; set; }
Property Value
Type | Description |
---|---|
System.String |
ParameterFormulaValue
This indicates a formula value to provide as the value for the parameter for this runner step
Declaration
[EntityProperty(SQLType.NVarChar, true, FriendlyLabel = "Formula Value")]
[EntityDescription("This indicates a formula value to provide as the value for the parameter for this runner step.")]
string ParameterFormulaValue { get; set; }
Property Value
Type | Description |
---|---|
System.String |
ParameterName
The parameter name for the runner step that this should provide a value for. Can be null if SQLWrapperParameterID is used
If ParameterDefaultValue and ParameterFormulaValue are empty, this parameter is ignored.
Any changes to system parameters, such as AccountID, will be ignoredDeclaration
[EntityProperty(SQLType.NVarChar, (short)100, true)]
string ParameterName { get; set; }
Property Value
Type | Description |
---|---|
System.String |
ParentQueryRunnerID
The overall parent runner this parameter belongs to
Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityRelationship(EntityID.QueryRunner, "ID", SingleJoinType.One, "Parent Query Runner", "Parameters", DeleteWithRelationship = true, PartOfParentSet = true, LinkToItemInSet = false, InheritPermissions = true)]
[Required]
[EntityDescription("The overall parent runner this parameter belongs to")]
Guid ParentQueryRunnerID { get; set; }
Property Value
Type | Description |
---|---|
System.Guid |
ParentQueryRunnerStepID
The parent runner step this is a parameter for
Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityRelationship(EntityID.QueryRunnerStep, "ID", SingleJoinType.One, "Parent Query Runner Step", "Parameters", DeleteWithRelationship = true, PartOfParentSet = true, LinkToItemInSet = false, InheritPermissions = false)]
[Required]
[EntityDescription("The parent runner step this is a parameter for")]
Guid ParentQueryRunnerStepID { get; set; }
Property Value
Type | Description |
---|---|
System.Guid |
SQLWrapperParameterID
The parameter for the runner step that this should provide a value for. Can be null if ParameterName is used
If ParameterDefaultValue and ParameterFormulaValue are empty, this parameter is ignored.
Any changes to system parameters, such as AccountID, will be ignoredDeclaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.SQLTypeWrapper, "ID", SingleJoinType.ZeroToOne, "SQL Wrapper Parameter ID", "Query Runner Step Parameters", DeleteWithRelationship = true, PartOfParentSet = false, LinkToItemInSet = false, InheritPermissions = false)]
Guid? SQLWrapperParameterID { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Guid> |