[EntityDefinition(EntityID.AllocationMethod, "dbo.LT_AllocationMethods", "AllocationMethod", LabelColumn = "Name", IsStandingDataEntity = false, HelpURL = "help/financial-services-engine/allocations/allocation-paths/intro.html")]
[DefaultEntityIcon(ImageType.AllocationMethod)]
public interface IAllocationMethod : IBaseEntityWithPermissions, IHasFolderStructure, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties

Properties

Description

A user friendly description of this allocation method and its uses

Declaration

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

Property Value

Type	Description
string

DynamicColumnAmountA

Links to ISQLTypeWrapper. The column in the DynamicSQLWrapperID that holds the total amount a

Declaration

[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.SQLTypeWrapper, "ID", SingleJoinType.ZeroToOne, "SQL Wrapper Type", "Dynamic Allocation Method Amount A", DeleteWithRelationship = false, PartOfParentSet = false, LinkToItemInSet = false)]
[EntityDescription("A query that given this allocation method holds the amount A to dynamically update the path with.")]
Guid? DynamicColumnAmountA { get; set; }

Property Value

Type	Description
Guid?

DynamicColumnAmountB

Links to ISQLTypeWrapper. The column in the DynamicSQLWrapperID that holds the total amount b

Declaration

[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.SQLTypeWrapper, "ID", SingleJoinType.ZeroToOne, "SQL Wrapper Type", "Dynamic Allocation Method Amount B", DeleteWithRelationship = false, PartOfParentSet = false, LinkToItemInSet = false)]
[EntityDescription("A query that given this allocation method holds the amount B to dynamically update the path with.")]
Guid? DynamicColumnAmountB { get; set; }

Property Value

Type	Description
Guid?

DynamicColumnEffectiveDate

Links to ISQLTypeWrapper. The column in the DynamicSQLWrapperID that holds the rule effective date

Declaration

[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.SQLTypeWrapper, "ID", SingleJoinType.ZeroToOne, "SQL Wrapper Type", "Dynamic Allocation Method Effective Date", DeleteWithRelationship = false, PartOfParentSet = false, LinkToItemInSet = false)]
[EntityDescription("Optional - default is effective date the query is run for. If provided this is the date used to update the allocation amounts effective from.")]
Guid? DynamicColumnEffectiveDate { get; set; }

Property Value

Type	Description
Guid?

DynamicColumnRuleAllocateToEntity

Links to ISQLTypeWrapper. The column in the DynamicSQLWrapperID that holds the rule entity to allocate to

Declaration

[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.SQLTypeWrapper, "ID", SingleJoinType.ZeroToOne, "SQL Wrapper Type", "Dynamic Allocation Method Rule Allocate To Entity", DeleteWithRelationship = false, PartOfParentSet = false, LinkToItemInSet = false)]
[EntityDescription("Required: A query that given this allocation method holds the rule Entity to allocate to and dynamically update the path with.")]
Guid? DynamicColumnRuleAllocateToEntity { get; set; }

Property Value

Type	Description
Guid?

DynamicColumnRuleEntity

Links to ISQLTypeWrapper. The column in the DynamicSQLWrapperID that holds the rule entity

Declaration

[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.SQLTypeWrapper, "ID", SingleJoinType.ZeroToOne, "SQL Wrapper Type", "Dynamic Allocation Method Rule Entity", DeleteWithRelationship = false, PartOfParentSet = false, LinkToItemInSet = false)]
[EntityDescription("Optional if the path only has one allocation path rule, where all allocated entities reside. A query that given this allocation path holds the rule Entity to dynamically update the path with.")]
Guid? DynamicColumnRuleEntity { get; set; }

Property Value

Type	Description
Guid?

DynamicSQLWrapperID

Links to ISQLWrapper. For a query that can update the path

Declaration

[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.SQLWrapper, "ID", SingleJoinType.ZeroToOne, "SQL Wrapper", "Dynamic Allocation Methods", DeleteWithRelationship = false, PartOfParentSet = false, LinkToItemInSet = false)]
[EntityDescription("A query that given this allocation method (@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? DynamicSQLWrapperID { get; set; }

Property Value

Type	Description
Guid?

Name

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

Declaration

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

Property Value

Type	Description
string

Extension Methods

LinqExtensions.AsArray<T>(T)

LinqExtensions.ToArrayOfOne<T>(T)

LinqExtensions.ToListOfOne<T>(T)

MiscExtensions.SetIfNotEqual<T, TP>(T, Expression<Func<T, TP>>, TP)

WeakReferenceExtensions.WeakReference(object)

SQLExtensions.ToSQLValue(object, bool)

ReflectionExtensions.ClearEventInvocations(object, string)

StringExtensions.ToCSVFormatString(object, Type)