Interface IFavourite
The system entity for favourites
Inherited Members
Namespace: LemonEdge.API.Entities.Data
Assembly: LemonEdge.API.dll
Syntax
[EntityDefinition(EntityID.Favourite, "dbo.LT_Favourites", "Favourite", LabelColumn = "Name", DontPromoteFromCanvas = true)]
[DefaultEntityIcon(ImageType.Favourite)]
[EntityIndex(Name = "Favourites", ColumnNames = new string[] { "FavouriteID", "ModifiedByUserID" }, IndexOrder = new IndexOrder[] { IndexOrder.Ascending, IndexOrder.Ascending }, IsClustered = false, IsUnique = true)]
public interface IFavourite : IBaseEntityWithPermissions, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties
Properties
CustomLayoutID
Links to ILayout. Any custom layout to apply to this item when being displayed.
Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.Layouts, "ID", SingleJoinType.ZeroToOne, "Custom Layout", "Favourites", DeleteWithRelationship = true, PartOfParentSet = false, LinkToItemInSet = false, InheritPermissions = false, PreventAutoConstraint = false)]
[EntityDescription("Any custom layout to apply to this item when being displayed.")]
Guid? CustomLayoutID { get; set; }
Property Value
Type | Description |
---|---|
Guid? |
FavouriteID
[Key] The globally unique id of the entity (of type FavouriteTypeID) being linked to
Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityDescription("The item itself.")]
[EntityKeyProperty]
[EntityLinkToAnyParentRelationship("FavouriteTypeID", SingleJoinType.One, "Favourites", false, new Type[] { typeof(IVennSetQueryableItem), typeof(ISQLTypeWrapper), typeof(IDatasetQueryableItem) }, OnlyWithLabels = true)]
Guid FavouriteID { get; set; }
Property Value
Type | Description |
---|---|
Guid |
FavouriteTypeID
[Key] The type of entity that is being linked to
Declaration
[EntityProperty(SQLType.UniqueIdentifier, false, IsEntityTypeLink = true)]
[EntityDescription("The type of item.")]
[EntityKeyProperty]
Guid FavouriteTypeID { get; set; }
Property Value
Type | Description |
---|---|
Guid |
Name
The name of the item being linked to by this favourite entity. Usually just the label from the entity as defined by LabelColumn
Declaration
[EntityProperty(SQLType.NVarChar, 500, false)]
[EntityDescription("The name of the item being linked to.")]
[Required]
string Name { get; set; }
Property Value
Type | Description |
---|---|
string |