[EntityDefinition(EntityID.AllocationMapping, "dbo.LT_AllocationMappings", "AllocationMapping", IsStandingDataEntity = false, HelpURL = "help/financial-services-engine/allocations/allocation-mappings/intro.html")]
[DefaultEntityIcon(ImageType.Map)]
public interface IAllocationMapping : IBaseEntityWithPermissions, IHasFolderStructure, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties

Properties

AllocationOverrideDate

Provides an override date to use for allocating mapped instrument/transactions

Declaration

[EntityProperty(SQLType.DateTimeOffset, true, IsDate = true)]
[EntityDescription("Provides an override date to use for allocating mapped instrument/transactions")]
DateTimeOffset? AllocationOverrideDate { get; set; }

Property Value

Type	Description
DateTimeOffset?

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, "Allocation Path", "Mappings", DeleteWithRelationship = true, PartOfParentSet = false, LinkToItemInSet = false, InheritPermissions = false)]
[RequiredNoDefaultIDValidation]
[EntityDescription("The path this lot is uniquely mapped to.")]
Guid AllocationPathID { get; set; }

Property Value

Type	Description
Guid

ChainFromAllocationPathID

Links to IEntitySet. Indicates anything allocated from this allocation path, to the entity set associated with the allocation path, is chained into that allocation path. Meaning anythingfrom this underlying entity set is allocated through this path to this path above. Right now InstrumentSet should be null, but will be enhanced in the future.

Declaration

[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.AllocationPath, "ID", SingleJoinType.ZeroToOne, "Chain From Allocation Path", "Chained Mappings From", DeleteWithRelationship = true, PartOfParentSet = false, LinkToItemInSet = false, InheritPermissions = false)]
[EntityKeyProperty]
[EntityDescription("Indicates anything allocated from this allocation path, to the entity set associated with the allocation path, is chained into that allocation path.\r\nMeaning anythingfrom this underlying entity set is allocated through this path to this path above.\r\nRight now InstrumentSet should be null, but will be enhanced in the future.")]
Guid? ChainFromAllocationPathID { get; set; }

Property Value

Type	Description
Guid?

ChainFromEntitySetID

Links to IEntitySet. Indicates anything allocated from this entity set, to the entity set associated with the allocation path, is chained into that allocation path. Meaning anythingfrom this underlying entity set is allocated through it's path to this path above. Right now InstrumentSet should be null, the system only deals with allocating through to one path, but will be enhanced in the future.

Declaration

[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.EntitySet, "ID", SingleJoinType.ZeroToOne, "Chain From Entity Set", "Chained Mappings From", DeleteWithRelationship = true, PartOfParentSet = false, LinkToItemInSet = false, InheritPermissions = false)]
[EntityKeyProperty]
[EntityDescription("Indicates anything allocated from this entity set, to the entity set associated with the allocation path, is chained into that allocation path.\r\nMeaning anythingfrom this underlying entity set is allocated through it's path to this path above.\r\nRight now InstrumentSet should be null, the system only deals with allocating through to one path, but will be enhanced in the future.")]
Guid? ChainFromEntitySetID { get; set; }

Property Value

Type	Description
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", "Allocation Mappings", DeleteWithRelationship = true, PartOfParentSet = false, LinkToItemInSet = false, InheritPermissions = false)]
[EntityKeyProperty]
[EntityDescription("The instrument that is uniquely mapped to the specified path.")]
Guid? InstrumentID { get; set; }

Property Value

Type	Description
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, "Instrument Set", "Allocation Mappings", DeleteWithRelationship = true, PartOfParentSet = false, LinkToItemInSet = false, InheritPermissions = false)]
[EntityKeyProperty]
[EntityDescription("The set of instruments that are uniquely mapped to the specified path.")]
Guid? InstrumentSetID { get; set; }

Property Value

Type	Description
Guid?

TransactionCodeID

Links to ITransactionCode. Indicates an optional Transaction Code to associate with this Allocation Mapping.

Declaration

[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.TransactionCode, "ID", SingleJoinType.ZeroToOne, "Transaction Code", "Allocation Mappings", PreventAutoConstraint = true)]
[EntityDescription("Indicates an optional Transaction Code to associate with this Allocation Mapping.")]
[EntityKeyProperty]
Guid? TransactionCodeID { get; set; }