[EntityDefinition(EntityID.Roles, "dbo.LT_Roles", "Role", LabelColumn = "Name", IsStandingDataEntity = true, HelpURL = "roles")]
[DefaultEntityIcon(ImageType.Role)]
public interface IRole : IBaseEntityWithPermissions, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties, ISetCopier

Properties

Description

A user friendly description of the purpose for this role

Declaration

[EntityProperty(SQLType.NVarChar, (short)2000, true)]
[EntityDescription("A user friendly description of this roles function.")]
string Description { get; set; }

Property Value

Type	Description
System.String

IsSystem

Indicates this is one of the two system provided roles - Admin and Standard User.

Declaration

[EntityProperty(SQLType.Bit, false, "0")]
[EntityDescription("Indicates this is a role maintained by the system, and will automatically be modified on upgrades. You can not edit this role.")]
bool IsSystem { get; set; }

Property Value

Type	Description
System.Boolean

Name

[Key] A unique user friendly name for this role.

Declaration

[EntityProperty(SQLType.NVarChar, (short)500, false)]
[EntityDescription("The unique name of this role.")]
[Required]
string Name { get; set; }

Property Value

Type	Description
System.String

RoleHelpURL

If you have created a custom role with specific functionality, you can provide a help url to ensure users can get access to a help guide through how to use the role.

Declaration

[EntityProperty(SQLType.NVarChar, (short)2500, true)]
[EntityDescription("Holds the help url for this role. Defaults to the base help url if empty.")]
string RoleHelpURL { get; set; }

Property Value

Type	Description
System.String

Extension Methods

MiscExtensions.SetIfNotEqual<T, P>(T, Expression<Func<T, P>>, P)

ReflectionExtensions.ClearEventInvocations(Object, String)

StringExtensions.ToCSVFormatString(Object, Type)

SQLExtensions.ToSQLValue(Object, Boolean)