[EntityDefinition(EntityID.AllocationPath, "dbo.LT_AllocationPaths", "AllocationPath", LabelColumn = "Name", IsStandingDataEntity = false, HelpURL = "help/financial-services-engine/allocations/allocation-paths/intro.html")]
[DefaultEntityIcon(ImageType.Path)]
[MultipleUnique(new string[] { "Name", "EntitySetID" })]
public interface IAllocationPath : IBaseEntityWithPermissions, ISetCopier, IHasFolderStructure, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties

Properties

AllocationMethodID

Links to IAllocationMethod. For allocation method

Declaration

[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.AllocationMethod, "ID", SingleJoinType.ZeroToOne, "Allocation Method", "Dynamic Allocation Paths", DeleteWithRelationship = false, PartOfParentSet = false, LinkToItemInSet = false)]
[EntityDescription("Holds Allocation Method which has a query that given this allocation path (@pathID) and/or (@entitySetID) and/or (@effectiveDate) and/or (@stepChangeDate) and/or (@stepChangeTransactionDate) as paramneters returns a set of entities and amounts to allocate to for updating the path dynamically with.")]
Guid? AllocationMethodID { get; set; }

Property Value

Type	Description
Guid?

AutoCompletePath

Indicates when any changes are made to the path or its rules, the system will enumerate all entities/rules in the path Any rules that point to new entities not in the path will be added as long as a rule can be found. Either because it only has one rule, or it has a rule named the same as the rule it was allocated from.

Declaration

[EntityProperty(SQLType.Bit, false, "0")]
[EntityDescription("Indicates when any changes are made to the path or its rules, the system will enumerate all entities/rules in the path. \r\nAny rules that point to new entities not in the path will be added as long as a rule can be found. \r\nEither because it only has one rule, or it has a rule named the same as the rule it was allocated from.")]
bool AutoCompletePath { get; set; }

Property Value

Type	Description
bool

Description

A user friendly description of this allocation path and its uses

Declaration

[EntityProperty(SQLType.NVarChar, 2000, true)]
[EntityDescription("A user friendly description of this allocation path.")]
string Description { get; set; }

Property Value

Type	Description
string

DynamicLastUpdatedDate

Holds the last date the path was updated effective from

Declaration

[EntityProperty(SQLType.DateTimeOffset, true, IsDate = true)]
[EntityDescription("Holds the last date the path was updated effective from.")]
DateTimeOffset? DynamicLastUpdatedDate { get; set; }

Property Value

Type	Description
DateTimeOffset?

DynamicType

Indicates how the path should be dynamically updated

Declaration

[EntityProperty(SQLType.SmallInt, false, "0")]
[EntityDescription("Indicates how the path should be dynamically updated.")]
DynamicPathUpdateType DynamicType { get; set; }

Property Value

Type	Description
DynamicPathUpdateType

EntitySetID

Links to IEntitySet. The Entity Set this Allocation Path is contained within. i.e.The Allocation Path is creating a path through the entities within this entity set.

Declaration

[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityRelationship(EntityID.EntitySet, "ID", SingleJoinType.One, "Entity Set", "Allocation Paths", DeleteWithRelationship = false, PartOfParentSet = false, LinkToItemInSet = false)]
[RequiredNoDefaultIDValidation]
[EntityDescription("The entity set that this allocation path belongs to.")]
Guid EntitySetID { get; set; }

Property Value

Type	Description
Guid

Name

[Key] The unique user friendly name of this Allocation Path

Declaration

[EntityProperty(SQLType.NVarChar, 500, false)]
[EntityKeyProperty]
[EntityDescription("The unique name of this allocation path.")]
[Required]
string Name { get; set; }

Property Value

Type	Description
string

SplitByPropertyFormula

Holds the formula of transaction that will be used for path split

Declaration

[EntityProperty(SQLType.NVarChar, 2000, true)]
[EntityDescription("Formula for path splits")]
string SplitByPropertyFormula { get; set; }

Property Value

Type	Description
string

SplitByPropertyType

Holds the type of property of transaction that will be used for path split

Declaration

[EntityProperty(SQLType.SmallInt, false, "0")]
[EntityDescription("Path split type property to use from transaction")]
SplitByPropertyType SplitByPropertyType { get; set; }