Class QueryRunner
Assembly: LemonEdge.API.Entities.Auto.dll
Syntax
[DataContract]
public class QueryRunner : BaseEntityWithPermissions, IQueryRunner, IBaseEntityWithPermissions, ISetCopier, IHasVersion, IUserSpecific, IHasFolderStructure, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties, ICloneableAsync<IQueryRunner>, IUserSpecificPublicToggle, ISetCopierCloneAlterer
Constructors
QueryRunner()
Declaration
Properties
Base64SerializedQueryExecuter
Declaration
public string Base64SerializedQueryExecuter { get; set; }
Property Value
CopierCloneType
Declaration
public SetCopierCloneType CopierCloneType { get; set; }
Property Value
Description
A user friendly description for this query runner
Declaration
[StringLength(2000)]
public string Description { get; set; }
Property Value
DisableTestRuns
Indicates if this query runner can be run in test mode or not by the user
Declaration
public bool DisableTestRuns { get; set; }
Property Value
EntityTypeID
The type of entity to use as results to call other QueryRunHandlers.
Declaration
public Guid? EntityTypeID { get; set; }
Property Value
FolderID
The link to the folder this item is contained in
Declaration
public Guid? FolderID { get; set; }
Property Value
FolderID_Label
Declaration
public string FolderID_Label { get; set; }
Property Value
FolderID_Label_Silent
Declaration
[NotMapped]
public string FolderID_Label_Silent { get; set; }
Property Value
IsPublic
Indicates if this entity is visible to all users (public), or just the current user (private).
Directly maps to UserID property
Declaration
[NotMapped]
public bool IsPublic { get; set; }
Property Value
IsSystem
Indicates this item is part of the core system. Any changes will be overwritten if the version number is lower than
the provided version number and the item is also marked as a system item.
Declaration
[Required]
public bool IsSystem { get; set; }
Property Value
MergeSameFileTypes
Indicates if this query runner should attempt to merge the resulting files in certain ways. Currently only works on the client for excel files.
Declaration
[EnumDataType(typeof(QueryRunnerMergOption))]
public QueryRunnerMergOption MergeSameFileTypes { get; set; }
Property Value
Declaration
[NotMapped]
public string MergeSameFileTypes_Tooltip { get; set; }
Property Value
Name
[Key] The unique name for this query runner
Declaration
[Unique]
[Required(AllowEmptyStrings = false)]
[StringLength(500)]
public string Name { get; set; }
Property Value
SQLWrapperID
The sql wrapper this query runner executes and uses the results of to call other QueryRunHandlers
Declaration
public Guid? SQLWrapperID { get; set; }
Property Value
SQLWrapperID_Label
Declaration
public string SQLWrapperID_Label { get; set; }
Property Value
SQLWrapperID_Label_Silent
Declaration
[NotMapped]
public string SQLWrapperID_Label_Silent { get; set; }
Property Value
UserID
Links to IUser. Indicates if this entity record is private to just the specified user, or if it is
public to everyone (holding null)
Declaration
public Guid? UserID { get; set; }
Property Value
UserID_Label
Declaration
public string UserID_Label { get; set; }
Property Value
UserID_Label_Silent
Declaration
[NotMapped]
public string UserID_Label_Silent { get; set; }
Property Value
Version
Indicates the version number of this item. Changes will only be overwritten if the provided new item has a higer
version number than this one.
Declaration
[Required]
[DatabasePropertyValidation("MyItem.IsSystem", "var allUserTeams = await Cache.GetAllItems<LemonEdge.API.Entities.Administration.IUserTeam>(); (await Cache.GetAllItems<LemonEdge.API.Entities.Administration.ITeam>()).Any(x => allUserTeams.Where(ut => ut.UserID == User.ID).Select(ut => ut.TeamID).Contains(x.ID) && x.CanEditSystemItems)", "User is not authorized to modify system items.")]
public short Version { get; set; }
Property Value
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
Returns
| Type |
Description |
| Task |
A task inidicating the finishing of this method
|
CopyFromEntity(IBaseEntity)
Declaration
protected override void CopyFromEntity(IBaseEntity src)
Parameters
Overrides
CopyFromSource(IQueryRunner)
Updates all properties in this item to have the same properties as the source object.
Declaration
public void CopyFromSource(IQueryRunner source)
Parameters
| Type |
Name |
Description |
| IQueryRunner |
source |
The source object to copy all values from.
|
Determines whether the source item should be copied based on the provided relationship
Declaration
public bool CopyRelatedItem(IBaseEntity sourceItem, EntityRelationship rel)
Parameters
| Type |
Name |
Description |
| IBaseEntity |
sourceItem |
The original source item this item was copied from
|
| EntityRelationship |
rel |
The particular relationship from the source item
|
Returns
ToString()
Declaration
public override string ToString()
Returns
Overrides
Implements
Extension Methods