Interface IDatasetShortcut
The system entity for a query shortcut, which is used for dynamically enhancing datasets
Inherited Members
Namespace: LemonEdge.API.Entities.Reporting
Assembly: LemonEdge.API.dll
Syntax
[EntityDefinition(EntityID.DatasetShortcut, "dbo.LT_DatasetShortcuts", "DatasetShortcut", LabelColumn = "Name", IsStandingDataEntity = false)]
[DefaultEntityIcon(ImageType.QueryShortcut)]
[EntityLinkToAnyParentRelationshipModifier(EntityID.DataSourceIDs, "EntityID", "ID", ExcludeFromRelationship = true)]
[EntityLinkToAnyParentRelationshipModifier(EntityID.SQLWrapper, "OwnerEntityID", "ID", PartOfThisSet = false)]
[EntityIndex(Name = "Name", ColumnNames = new string[] { "UserID", "Name" }, IndexOrder = new IndexOrder[] { IndexOrder.Ascending, IndexOrder.Ascending }, IncludeColumns = new string[] { "SafeID", "IsSystem", "Version", "Description", "AlgorithmStepID", "FolderID" }, IsClustered = false, IsUnique = false)]
public interface IDatasetShortcut : IBaseEntityWithPermissions, ISetCopier, IHasVersion, IUserSpecific, IHasFolderStructure, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties
Properties
Available
Indicates where the user is available to use this shortcut from
Declaration
[EntityProperty(SQLType.SmallInt, false)]
[EntityDescription("Indicates where the user is available to use this shortcut from.")]
DatasetShorcutAvailability Available { get; set; }
Property Value
Type | Description |
---|---|
DatasetShorcutAvailability |
Description
A user friendly description of this query shortcut
Declaration
[EntityProperty(SQLType.NVarChar, 2000, true)]
[EntityDescription("A user friendly description of this query shortcut.")]
string Description { get; set; }
Property Value
Type | Description |
---|---|
string |
Name
The unique user friendly name of this query short cut
Declaration
[EntityProperty(SQLType.NVarChar, 500, false)]
[EntityKeyProperty]
[EntityDescription("The unique name of this dataset.")]
[Unique]
[Required]
string Name { get; set; }
Property Value
Type | Description |
---|---|
string |
QueryableItemID
The item of the specified type that you want to query
A queryable item inherits IQueryableItem
Declaration
[EntityProperty(SQLType.NVarChar, 500, true)]
[EntityDescription("The id of this queryable item.")]
string QueryableItemID { get; set; }
Property Value
Type | Description |
---|---|
string |
QueryableItemSubID
The sub id of this queryable item.
Declaration
[EntityProperty(SQLType.NVarChar, 500, true)]
[EntityDescription("The sub id of this queryable item.")]
string QueryableItemSubID { get; set; }
Property Value
Type | Description |
---|---|
string |
QueryableItemTypeName
The type of item you want to query. This can be an Entity, History, or Query.
Declaration
[EntityProperty(SQLType.NVarChar, 50, true)]
[EntityDescription("The type of queryable item.")]
string QueryableItemTypeName { get; set; }
Property Value
Type | Description |
---|---|
string |
Replace1QueryableItemID
The item of the specified type that you want to query that comes from replacing the main item from an override
A queryable item inherits IQueryableItem
Declaration
[EntityProperty(SQLType.NVarChar, 500, true)]
[EntityDescription("The id of this queryable item that comes from replacing the main item from an override.")]
string Replace1QueryableItemID { get; set; }
Property Value
Type | Description |
---|---|
string |
Replace1QueryableItemSubID
The sub id of this queryable item that comes from replacing the main item from an override.
Declaration
[EntityProperty(SQLType.NVarChar, 500, true)]
[EntityDescription("The sub id of this queryable item that comes from replacing the main item from an override.")]
string Replace1QueryableItemSubID { get; set; }
Property Value
Type | Description |
---|---|
string |
Replace1QueryableItemTypeName
The type of item you want to query that comes from replacing the main item from an override. This can be an Entity, History, or Query.
Declaration
[EntityProperty(SQLType.NVarChar, 50, true)]
[EntityDescription("The type of queryable item that comes from replacing the main item from an override.")]
string Replace1QueryableItemTypeName { get; set; }
Property Value
Type | Description |
---|---|
string |
Replace2QueryableItemID
The item of the specified type that you want to query that comes from replacing the main item from an override
A queryable item inherits IQueryableItem
Declaration
[EntityProperty(SQLType.NVarChar, 500, true)]
[EntityDescription("The id of this queryable item that comes from replacing the main item from an override.")]
string Replace2QueryableItemID { get; set; }
Property Value
Type | Description |
---|---|
string |
Replace2QueryableItemSubID
The sub id of this queryable item that comes from replacing the main item from an override.
Declaration
[EntityProperty(SQLType.NVarChar, 500, true)]
[EntityDescription("The sub id of this queryable item that comes from replacing the main item from an override.")]
string Replace2QueryableItemSubID { get; set; }
Property Value
Type | Description |
---|---|
string |
Replace2QueryableItemTypeName
The type of item you want to query that comes from replacing the main item from an override. This can be an Entity, History, or Query.
Declaration
[EntityProperty(SQLType.NVarChar, 50, true)]
[EntityDescription("The type of queryable item that comes from replacing the main item from an override.")]
string Replace2QueryableItemTypeName { get; set; }
Property Value
Type | Description |
---|---|
string |
Replace3QueryableItemID
The item of the specified type that you want to query that comes from replacing the main item from an override
A queryable item inherits IQueryableItem
Declaration
[EntityProperty(SQLType.NVarChar, 500, true)]
[EntityDescription("The id of this queryable item that comes from replacing the main item from an override.")]
string Replace3QueryableItemID { get; set; }
Property Value
Type | Description |
---|---|
string |
Replace3QueryableItemSubID
The sub id of this queryable item that comes from replacing the main item from an override.
Declaration
[EntityProperty(SQLType.NVarChar, 500, true)]
[EntityDescription("The sub id of this queryable item that comes from replacing the main item from an override.")]
string Replace3QueryableItemSubID { get; set; }
Property Value
Type | Description |
---|---|
string |
Replace3QueryableItemTypeName
The type of item you want to query that comes from replacing the main item from an override. This can be an Entity, History, or Query.
Declaration
[EntityProperty(SQLType.NVarChar, 50, true)]
[EntityDescription("The type of queryable item that comes from replacing the main item from an override.")]
string Replace3QueryableItemTypeName { get; set; }
Property Value
Type | Description |
---|---|
string |
Replace4QueryableItemID
The item of the specified type that you want to query that comes from replacing the main item from an override
A queryable item inherits IQueryableItem
Declaration
[EntityProperty(SQLType.NVarChar, 500, true)]
[EntityDescription("The id of this queryable item that comes from replacing the main item from an override.")]
string Replace4QueryableItemID { get; set; }
Property Value
Type | Description |
---|---|
string |
Replace4QueryableItemSubID
The sub id of this queryable item that comes from replacing the main item from an override.
Declaration
[EntityProperty(SQLType.NVarChar, 500, true)]
[EntityDescription("The sub id of this queryable item that comes from replacing the main item from an override.")]
string Replace4QueryableItemSubID { get; set; }
Property Value
Type | Description |
---|---|
string |
Replace4QueryableItemTypeName
The type of item you want to query that comes from replacing the main item from an override. This can be an Entity, History, or Query.
Declaration
[EntityProperty(SQLType.NVarChar, 50, true)]
[EntityDescription("The type of queryable item that comes from replacing the main item from an override.")]
string Replace4QueryableItemTypeName { get; set; }
Property Value
Type | Description |
---|---|
string |
Replace5QueryableItemID
The item of the specified type that you want to query that comes from replacing the main item from an override
A queryable item inherits IQueryableItem
Declaration
[EntityProperty(SQLType.NVarChar, 500, true)]
[EntityDescription("The id of this queryable item that comes from replacing the main item from an override.")]
string Replace5QueryableItemID { get; set; }
Property Value
Type | Description |
---|---|
string |
Replace5QueryableItemSubID
The sub id of this queryable item that comes from replacing the main item from an override.
Declaration
[EntityProperty(SQLType.NVarChar, 500, true)]
[EntityDescription("The sub id of this queryable item that comes from replacing the main item from an override.")]
string Replace5QueryableItemSubID { get; set; }
Property Value
Type | Description |
---|---|
string |
Replace5QueryableItemTypeName
The type of item you want to query that comes from replacing the main item from an override. This can be an Entity, History, or Query.
Declaration
[EntityProperty(SQLType.NVarChar, 50, true)]
[EntityDescription("The type of queryable item that comes from replacing the main item from an override.")]
string Replace5QueryableItemTypeName { get; set; }
Property Value
Type | Description |
---|---|
string |
Replace6QueryableItemID
The item of the specified type that you want to query that comes from replacing the main item from an override
A queryable item inherits IQueryableItem
Declaration
[EntityProperty(SQLType.NVarChar, 500, true)]
[EntityDescription("The id of this queryable item that comes from replacing the main item from an override.")]
string Replace6QueryableItemID { get; set; }
Property Value
Type | Description |
---|---|
string |
Replace6QueryableItemSubID
The sub id of this queryable item that comes from replacing the main item from an override.
Declaration
[EntityProperty(SQLType.NVarChar, 500, true)]
[EntityDescription("The sub id of this queryable item that comes from replacing the main item from an override.")]
string Replace6QueryableItemSubID { get; set; }
Property Value
Type | Description |
---|---|
string |
Replace6QueryableItemTypeName
The type of item you want to query that comes from replacing the main item from an override. This can be an Entity, History, or Query.
Declaration
[EntityProperty(SQLType.NVarChar, 50, true)]
[EntityDescription("The type of queryable item that comes from replacing the main item from an override.")]
string Replace6QueryableItemTypeName { get; set; }
Property Value
Type | Description |
---|---|
string |