Class Report

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

Constructors

Report()

Declaration
public Report()

Properties

Description

A user friendly description for this report

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

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

InheritingObjectTypeID

Any object that inherits this interface holds part of a record, the common base part

This holds the type of record which holds the rest

The IDs of both the inheriting and base objects always are the same
Declaration
[RequiredNoDefaultIDValidation]
[Unique(MergeWithAnyOtherUniqueProperties = true)]
public Guid InheritingObjectTypeID { get; set; }
Property Value
Type Description
Guid

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 name of this report.

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

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

CopyFromEntity(IBaseEntity)

Declaration
protected override void CopyFromEntity(IBaseEntity src)
Parameters
Type Name Description
IBaseEntity src
Overrides

CopyFromSource(IReport)

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

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

The source object to copy all values from.

ToString()

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

Implements

Extension Methods