Interface ICompiledPath

The system entity for the results of a compiled allocation path

Inherited Members
Namespace: LemonEdge.API.Entities.FinancialServices.Transactions
Assembly: LemonEdge.API.Entities.FinancialServices.dll
Syntax
[EntityDefinition(EntityID.CompiledPath, "dbo.LT_CompiledPaths", "CompiledPath", IsStandingDataEntity = false)]
[DefaultEntityIcon(ImageType.Path)]
[EntityIndex(Name = "CompiledPathWithDate", ColumnNames = new string[] { "PathID" }, IndexOrder = new IndexOrder[] { IndexOrder.Ascending }, IncludeColumns = new string[] { "EffectiveDate", "Timing" }, IsClustered = false, IsUnique = false)]
public interface ICompiledPath : IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties

Properties

EffectiveDate

The date this allocation within the compiled path is effective from

Declaration
[EntityProperty(SQLType.DateTimeOffset, false)]
[RequiredNoDefaultIDValidation]
[EntityKeyProperty]
[EntityDescription("The date this allocation within the compiled path is effective from.")]
DateTimeOffset EffectiveDate { get; set; }
Property Value
Type Description
DateTimeOffset

FromEntityID

[Key] Links to IObjectEntity. The original entity in the path this allocation is from

Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityKeyProperty]
[EntityRelationship(EntityID.ObjectEntity, "ID", SingleJoinType.One, "From Entity", "Compiled Paths As From Entity", DeleteWithRelationship = true, PartOfParentSet = false, LinkToItemInSet = false)]
[RequiredNoDefaultIDValidation]
[EntityDescription("The original entity in the path this allocation is from.")]
Guid FromEntityID { get; set; }
Property Value
Type Description
Guid

IncludeEntityInAllocation

Indicates this allocation of the compiled path is included because the from entity in the path has been marked as IncludeEntityInAllocation

Declaration
[EntityProperty(SQLType.Bit, false)]
[RequiredNoDefaultIDValidation]
[EntityDescription("Indicates this allocation of the compiled path is included because the from entity in the path has been marked as IAllocationPathRule.IncludeEntityInAllocation.")]
bool IncludeEntityInAllocation { get; set; }
Property Value
Type Description
bool

Level

The level this entity resides within the path

Declaration
[EntityProperty(SQLType.SmallInt, false)]
[RequiredNoDefaultIDValidation]
[EntityDescription("The level this entity resides within the path.")]
short Level { get; set; }
Property Value
Type Description
short

PathID

[Key] Links to IAllocationPath. The path this compilation belongs to

Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityKeyProperty]
[EntityRelationship(EntityID.AllocationPath, "ID", SingleJoinType.One, "Allocation Path", "Compiled Paths", DeleteWithRelationship = true, PartOfParentSet = false, LinkToItemInSet = false, InheritPermissions = true)]
[RequiredNoDefaultIDValidation]
[EntityDescription("The path this compilation belongs to.")]
Guid PathID { get; set; }
Property Value
Type Description
Guid

PathSplitId

The path split used to create this path segment

Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityDescription("The path split used to create this path segment")]
Guid? PathSplitId { get; set; }
Property Value
Type Description
Guid?

Pct

The percentage to be allocated of a transaction originating at 'source entity' for amount A through this path from 'from entity', to 'to entity', via the 'root entity'

Declaration
[EntityProperty(SQLType.Decimal, 25, 23, false)]
[EntityDescription("The percentage to be allocated of a transaction originating at 'source entity' for amount A through this path from 'from entity', to 'to entity', via the 'root entity'.")]
decimal Pct { get; set; }
Property Value
Type Description
decimal

PctB

The percentage to be allocated of a transaction originating at 'source entity' for amount B through this path from 'from entity', to 'to entity', via the 'root entity'

Declaration
[EntityProperty(SQLType.Decimal, 25, 23, false)]
[EntityDescription("The percentage to be allocated of a transaction originating at 'source entity' for amount B through this path from 'from entity', to 'to entity', via the 'root entity'.")]
decimal PctB { get; set; }
Property Value
Type Description
decimal

RootEntityID

[Key] Links to IObjectEntity. The root entity this allocation passes through

Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityKeyProperty]
[EntityRelationship(EntityID.ObjectEntity, "ID", SingleJoinType.One, "Root Entity", "Compiled Paths As Root Entity", DeleteWithRelationship = true, PartOfParentSet = false, LinkToItemInSet = false)]
[RequiredNoDefaultIDValidation]
[EntityDescription("The root entity this allocation passes through.")]
Guid RootEntityID { get; set; }
Property Value
Type Description
Guid

RoundingToEntityID

[Key] Links to IObjectEntity. The to entity within this allocation path that should be used by the system to take any rounding difference.

Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityKeyProperty]
[EntityRelationship(EntityID.ObjectEntity, "ID", SingleJoinType.One, "Rounding Entity", "Compiled Paths As Rounding Entity", DeleteWithRelationship = true, PartOfParentSet = false, LinkToItemInSet = false)]
[EntityDescription("The to entity within this allocation path that should be used by the system to take any rounding difference..")]
Guid RoundingToEntityID { get; set; }
Property Value
Type Description
Guid

SourceEntityID

[Key] Links to IObjectEntity. The entity this amount is being allocated from to the allocated entity

Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityKeyProperty]
[EntityRelationship(EntityID.ObjectEntity, "ID", SingleJoinType.One, "Source Entity", "Compiled Paths As Source Entity", DeleteWithRelationship = true, PartOfParentSet = false, LinkToItemInSet = false)]
[RequiredNoDefaultIDValidation]
[EntityDescription("The entity this amount is being allocated from to the allocated entity.")]
Guid SourceEntityID { get; set; }
Property Value
Type Description
Guid

StepChangeDate

Indicates this allocation comes from an allocation amount created with a step change process

Declaration
[EntityProperty(SQLType.DateTimeOffset, true)]
[EntityDescription("Indicates this allocation comes from an allocation amount created with a step change process.")]
DateTimeOffset? StepChangeDate { get; set; }
Property Value
Type Description
DateTimeOffset?

Timing

Indicates the time of day this allocation is effective from

Declaration
[EntityProperty(SQLType.SmallInt, false)]
[RequiredNoDefaultIDValidation]
[EntityDescription("Indicates the time of day this allocation is effective from.")]
AllocationTiming Timing { get; set; }
Property Value
Type Description
AllocationTiming

ToEntityID

[Key] Links to IObjectEntity. The entity this amount is being allocated to

Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityKeyProperty]
[EntityRelationship(EntityID.ObjectEntity, "ID", SingleJoinType.One, "To Entity", "Compiled Paths As To Entity", DeleteWithRelationship = true, PartOfParentSet = false, LinkToItemInSet = false)]
[RequiredNoDefaultIDValidation]
[EntityDescription("The entity this amount is being allocated to.")]
Guid ToEntityID { get; set; }
Property Value
Type Description
Guid

TransferID

[Key] Links to ITransfer. The transfer record which automated the creation of this movement in the path

Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityKeyProperty]
[EntityRelationship(EntityID.Transfer, "ID", SingleJoinType.ZeroToOne, "Transfer", "Compiled Paths", DeleteWithRelationship = true, PartOfParentSet = false, LinkToItemInSet = false)]
[EntityDescription("The transfer record which automated the creation of this movement in the path.")]
Guid? TransferID { get; set; }
Property Value
Type Description
Guid?

Extension Methods

See Also