Class Dataset

Inheritance
object
BaseEntity
BaseEntityWithPermissions
Dataset
Implements
Inherited Members
Namespace: LemonEdge.API.Entities.Reporting
Assembly: LemonEdge.API.Entities.Auto.dll
Syntax
[DataContract]
public class Dataset : BaseEntityWithPermissions, IDataset, IBaseEntityWithPermissions, ISetCopier, IHasVersion, IUserSpecific, IHasFolderStructure, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties, ICloneableAsync<IDataset>, IUserSpecificPublicToggle, ISetCopierCloneAlterer, ISetItemLoaderOverride

Constructors

Dataset()

Declaration
public Dataset()

Properties

CopierCloneType

Declaration
public SetCopierCloneType CopierCloneType { get; set; }
Property Value
Type Description
SetCopierCloneType

DatasetTemplateID

The link to the dataset shortcut that is using this datase as a template

Declaration
public Guid? DatasetTemplateID { get; set; }
Property Value
Type Description
Guid?

DatasetTemplateID_Label

Declaration
public string DatasetTemplateID_Label { get; set; }
Property Value
Type Description
string

DatasetTemplateID_Label_Silent

Declaration
[NotMapped]
public string DatasetTemplateID_Label_Silent { get; set; }
Property Value
Type Description
string

Description

A user friendly description of this dataset

Declaration
[StringLength(2000)]
public string Description { get; set; }
Property Value
Type Description
string

DisplayItemOnCopy

Indicates if the items should appear in the UI when copied from a grid. Typically child items shouldn't be added as items in a grid or opened on copy, just the root item itself

Declaration
public bool DisplayItemOnCopy { get; set; }
Property Value
Type Description
bool

Distinct

Indicates all rows returned must be distinct removing any duplicate values

Declaration
public bool Distinct { get; set; }
Property Value
Type Description
bool

FolderID

The link to the folder this item is contained in

Declaration
public Guid? FolderID { get; set; }
Property Value
Type Description
Guid?

FolderID_Label

Declaration
public string FolderID_Label { get; set; }
Property Value
Type Description
string

FolderID_Label_Silent

Declaration
[NotMapped]
public string FolderID_Label_Silent { get; set; }
Property Value
Type Description
string

ForceNewItemOnCopy

Indicates if the specified item should always be created as a new item. For instance when copying sub transactions are always created as new items

Declaration
public bool ForceNewItemOnCopy { get; set; }
Property Value
Type Description
bool

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
Type Description
bool

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
Type Description
bool

Name

The unique user friendly name of this dataset

Declaration
[Unique]
[Required]
[StringLength(500)]
public string Name { get; set; }
Property Value
Type Description
string

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
[RequiredNoDefaultIDValidation]
public Guid SQLWrapperID { get; set; }
Property Value
Type Description
Guid

SQLWrapperID_Label

Declaration
public string SQLWrapperID_Label { get; set; }
Property Value
Type Description
string

SQLWrapperID_Label_Silent

Declaration
[NotMapped]
public string SQLWrapperID_Label_Silent { get; set; }
Property Value
Type Description
string

SetMethod

Specifies the method to use for combining data together - either a single statement or via temp tables

Declaration
[EnumDataType(typeof(DataSetSetOperatorMethod))]
public DataSetSetOperatorMethod SetMethod { get; set; }
Property Value
Type Description
DataSetSetOperatorMethod

SetMethod_Tooltip

Declaration
[NotMapped]
public string SetMethod_Tooltip { get; set; }
Property Value
Type Description
string

Skip

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

Declaration
public int? Skip { get; set; }
Property Value
Type Description
int?

Top

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

Declaration
public int? Top { get; set; }
Property Value
Type Description
int?

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
Type Description
Guid?

UserID_Label

Declaration
public string UserID_Label { get; set; }
Property Value
Type Description
string

UserID_Label_Silent

Declaration
[NotMapped]
public string UserID_Label_Silent { get; set; }
Property Value
Type Description
string

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
Type Description
short

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

CopyFromSource(IDataset)

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

Declaration
public void CopyFromSource(IDataset source)
Parameters
Type Name Description
IDataset source

The source object to copy all values from.

CopyRelatedItem(IBaseEntity, EntityRelationship)

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
Type Description
bool

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides

Implements

Extension Methods