Interface IAllocationMapping

The system entity for allocation mappings, which dynamically associate paths and instruments

See https://web.lemonedge.com/help/allocation-mappings/ 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.AllocationMapping, "dbo.LT_AllocationMappings", "AllocationMapping", IsStandingDataEntity = false, HelpURL = "allocation-mappings")]
[DefaultEntityIcon(ImageType.Map)]
public interface IAllocationMapping : IBaseEntityWithPermissions, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties

Properties

AllocationPathID

Links to IAllocationPath. The Allocation Path that will be associated with the specified Instrument or Instrument Set

Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityRelationship(EntityID.AllocationPath, "ID", SingleJoinType.One, "AllocationMapping", "AllocationPath", DeleteWithRelationship = true, PartOfParentSet = false, LinkToItemInSet = false, InheritPermissions = false)]
[EntityDescription("The path this lot is uniquely mapped to.")]
Guid AllocationPathID { get; set; }
Property Value
Type Description
System.Guid

ChainFromEntitySetAllocatedToEntityID

Links to IObjectEntity. Indicates this Entity is specifically associated with the Allocation Path whenever the entity is allocated to from a sub entity set. In other words enabling chaining of paths across entity sets.

Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.ObjectEntity, "ID", SingleJoinType.ZeroToOne, "Chain Allocate To Entity", "Chained Mappings", DeleteWithRelationship = true, PartOfParentSet = false, LinkToItemInSet = false, InheritPermissions = false)]
[EntityDescription("Indicates this Entity is specifically associated with the Allocation Path whenever the entity is allocated to from a sub entity set. In other words enabling chaining of paths across entity sets.")]
Guid? ChainFromEntitySetAllocatedToEntityID { get; set; }
Property Value
Type Description
System.Nullable<System.Guid>

ChainFromEntitySetID

Links to IEntitySet. Indicates this Entity Set is specifically associated with the Allocation Path whenever the entity is allocated to from a sub entity set. In other words enabling chaining of paths across entity sets.

Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.EntitySet, "ID", SingleJoinType.ZeroToOne, "Chain From Entity Set", "Chained Mappings", DeleteWithRelationship = true, PartOfParentSet = false, LinkToItemInSet = false, InheritPermissions = false)]
[EntityDescription("Indicates this Entity Set is specifically associated with the Allocation Path whenever the entity is allocated to from a sub entity set. In other words enabling chaining of paths across entity sets.")]
Guid? ChainFromEntitySetID { get; set; }
Property Value
Type Description
System.Nullable<System.Guid>

ChainToEntitySetAllocatedFromEntityID

Links to IObjectEntity. Indicates this Entity is specifically associated with the Allocation Path whenever the entity is allocated to from a sub entity set. In other words enabling chaining of paths across entity sets.

Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.ObjectEntity, "ID", SingleJoinType.ZeroToOne, "Chain Allocate From Entity", "Chained Mappings", DeleteWithRelationship = true, PartOfParentSet = false, LinkToItemInSet = false, InheritPermissions = false)]
[EntityDescription("Indicates this Entity is specifically associated with the Allocation Path whenever the entity is allocated to from a sub entity set. In other words enabling chaining of paths across entity sets.")]
Guid? ChainToEntitySetAllocatedFromEntityID { get; set; }
Property Value
Type Description
System.Nullable<System.Guid>

InstrumentID

Links to IInstrument. Indicates this Instrument is specifically associated with the Allocation Path. Either this field or the InstrumentSetID field is required to have a value

Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.Instrument, "ID", SingleJoinType.ZeroToOne, "Instrument", "AllocationPath", DeleteWithRelationship = true, PartOfParentSet = false, LinkToItemInSet = false, InheritPermissions = false)]
[EntityDescription("The instrument that is uniquely mapped to the specified path.")]
Guid? InstrumentID { get; set; }
Property Value
Type Description
System.Nullable<System.Guid>

InstrumentSetID

Links to IInstrumentSet. Indicates all Instruments dynamically determined to be part of this Instrument Set will be associated with this Allocation Path. Either this field or the InstrumentID field is required to have a value

Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.InstrumentSet, "ID", SingleJoinType.ZeroToOne, "InstrumentSet", "AllocationPath", DeleteWithRelationship = true, PartOfParentSet = false, LinkToItemInSet = false, InheritPermissions = false)]
[EntityDescription("The set of instruments that are uniquely mapped to the specified path.")]
Guid? InstrumentSetID { get; set; }
Property Value
Type Description
System.Nullable<System.Guid>

Extension Methods

See Also