[EntityDefinition(EntityID.AllocationRule, "dbo.LT_AllocationRules", "AllocationRule", LabelColumn = "Name", IsStandingDataEntity = false, HelpURL = "help/financial-services-engine/allocations/allocation-rules/intro.html")]
[DefaultEntityIcon(ImageType.AllocationRule)]
[MultipleUnique(new string[] { "Name", "EntityID" })]
public interface IAllocationRule : 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 (@pathentityID) and/or (@ruleID) and/or (@pathSplitID) 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?

AllocationPathSplitType

Specifies how the allocation rule should handle PathSplit from AllocationPath. Default is SpecifiedSplit - use PathSplit when generating allocations. AlwaysIgnore option ignores Path Split and always produces the same results

Declaration

[EntityProperty(SQLType.SmallInt, false, "0")]
[EntityDescription("Specifies how the allocation rule should handle PathSplit from AllocationPath. Default is SpecifiedSplit - use PathSplit when generating allocations. AlwaysIgnore option ignores Path Split and always produces the same results")]
AllocationPathSplitType AllocationPathSplitType { get; set; }

Property Value

Type	Description
AllocationPathSplitType

AllocationPathType

The way in which allocations are calculated along a path. Default is that each vehicle in the path has its amount calculated from the total amount for entities it allocates to (TotalAmount)

Declaration

[EntityProperty(SQLType.SmallInt, false, "0")]
[EntityDescription("The way in which allocations are calculated along a path. Default is that each vehicle in the path has its amount calculated from the total amount for entities it allocates to (TotalAmount).")]
AllocationPathType AllocationPathType { get; set; }

Property Value

Type	Description
AllocationPathType

Description

A user friendly description of this allocation rule.

Declaration

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

Property Value

Type	Description
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, true)]
[EntityKeyProperty]
[EntityRelationship(EntityID.ObjectEntity, "ID", SingleJoinType.ZeroToOne, "Entity", "Allocation Rule Allocations To", DeleteWithRelationship = false, PartOfParentSet = false, LinkToItemInSet = false)]
[EntityDescription("The entity this allocation rule belongs to.")]
Guid? EntityID { get; set; }

Property Value

Type	Description
Guid?

EntitySetID

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

Declaration

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

Property Value

Type	Description
Guid?

Name

[Key] The unique user friendly name of this rule

Declaration

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