Interface IAllocationRule

The system entity for an allocation path rule, which belongs to an allocation path

See https://web.lemonedge.com/help/allocation-rules/ 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.AllocationRule, "dbo.LT_AllocationRules", "AllocationRule", LabelColumn = "Name", IsStandingDataEntity = false, HelpURL = "allocation-rules")]
[DefaultEntityIcon(ImageType.AllocationRule)]
public interface IAllocationRule : IBaseEntityWithPermissions, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties, ISetCopier

Properties

Description

A user friendly description of this allocation rule.

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

EntityID

[Key] Links to IObjectEntity. The entity within the entity set that this rule is for, and is allocating from

Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityRelationship(EntityID.ObjectEntity, "ID", SingleJoinType.One, "AllocationRule", "ObjectEntity", DeleteWithRelationship = false, PartOfParentSet = false, LinkToItemInSet = false)]
[EntityDescription("The entity this allocation rule belongs to.")]
Guid EntityID { get; set; }
Property Value
Type Description
System.Guid

EntitySetID

Links to IEntitySet. The entity set this rule is contained within

Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityRelationship(EntityID.EntitySet, "ID", SingleJoinType.One, "AllocationRule", "EntitySet", DeleteWithRelationship = false, PartOfParentSet = false, LinkToItemInSet = false)]
[EntityDescription("The entity set that this allocation rule belongs to.")]
Guid EntitySetID { get; set; }
Property Value
Type Description
System.Guid

Name

[Key] The unique user friendly name of this rule

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

Extension Methods

See Also