Interface IDataset

The system entity for a DataSet, which is used for dynamically creating reports for use throughout the system

See https://web.lemonedge.com/help/datasets/ for more information

Inherited Members
System.IEquatable<LemonEdge.API.Core.IBaseEntity>.Equals(LemonEdge.API.Core.IBaseEntity)
System.ComponentModel.INotifyPropertyChanged.PropertyChanged
System.ComponentModel.INotifyPropertyChanging.PropertyChanging
Namespace: LemonEdge.API.Entities
Assembly: API.dll
Syntax
[EntityDefinition(EntityID.Dataset, "dbo.LT_Datasets", "Dataset", LabelColumn = "Name", IsStandingDataEntity = false, HelpURL = "datasets")]
[DefaultEntityIcon(ImageType.Dataset)]
[EntityLinkToAnyParentRelationshipModifier(EntityID.Transaction, "ParentItemID", "ID", ExcludeFromRelationship = true)]
[EntityLinkToAnyParentRelationshipModifier(EntityID.DataSourceIDs, "EntityID", "ID", ExcludeFromRelationship = true)]
[EntityLinkToAnyParentRelationshipModifier(EntityID.SQLWrapper, "OwnerEntityID", "ID", PartOfThisSet = true)]
public interface IDataset : IBaseEntityWithPermissions, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties, ISetCopier, IHasVersion, IUserSpecific

Properties

Description

A user friendly description of this dataset

Declaration
[EntityProperty(SQLType.NVarChar, (short)2000, true)]
[EntityDescription("A user friendly description of this dataset.")]
string Description { get; set; }
Property Value
Type Description
System.String

Distinct

Indicates all rows returned must be distinct removing any duplicate values

Declaration
[EntityProperty(SQLType.Bit, false)]
[EntityDescription("Indicates if only distinct row results should be returned in this dataset.")]
bool Distinct { get; set; }
Property Value
Type Description
System.Boolean

Name

The unique user friendly name of this dataset

Declaration
[EntityProperty(SQLType.NVarChar, (short)500, false)]
[EntityDescription("The unique name of this dataset.")]
[Required]
string Name { get; set; }
Property Value
Type Description
System.String

Skip

Indicates the dataset should skip the specified number of rows (requires an order in the Columns) before returning the remaining amount

Declaration
[EntityProperty(SQLType.Int, true)]
[EntityDescription("Indicates if the specified number of rows should be skipped before returning the rows in this dataset.")]
int? Skip { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

SQLWrapperID

The link to the SQL Wrapper that allows you to execute this dataset, and otherwise interact with it throughout the whole LemonEdge platform.

This is automatically created and maintained by the system.You can leave it blank when creating a dataset.

Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityRelationship(EntityID.SQLWrapper, "ID", SingleJoinType.One, "SQLWrapper", "Dataset", DeleteWithRelationship = true, LinkToItemInSet = true, InheritPermissions = false, PreventAutoConstraint = true)]
[EntityDescription("Holds the sql wrapper this query generates.")]
Guid SQLWrapperID { get; set; }
Property Value
Type Description
System.Guid

Top

Indicates the dataset should always only return the following number of rows

Declaration
[EntityProperty(SQLType.Int, true)]
[EntityDescription("Indicates if just the top specified number of rows should be returned in this dataset.")]
int? Top { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

Extension Methods

See Also