Interface IPathInfo

A complex type definition for holding the results of executing the system default GetPathInfo sql wrapper query

Can be executed from GetPathInfo

Namespace: LemonEdge.API.ComplexTypes
Assembly: API.dll
Syntax
[ComplexDefinition(ImageType.Path, "Path Info")]
public interface IPathInfo

Properties

EffectiveDate

The effective date that the allocation percentages can be used from

Declaration
DateTimeOffset EffectiveDate { get; set; }
Property Value
Type Description
System.DateTimeOffset

FromEntityID

The entity to allocate from that the percentage relates to

Declaration
[Key]
[Column(Order = 1)]
Guid FromEntityID { get; set; }
Property Value
Type Description
System.Guid

FromEntityID_Label

The label for the from entity

Declaration
string FromEntityID_Label { get; set; }
Property Value
Type Description
System.String

IncludedEntityInAllocation

Indicates if this entity is only being allocated to as it is marked for being including in allocations in the path setup (IncludeEntityInAllocation)

Declaration
[Key]
[Column(Order = 5)]
bool IncludedEntityInAllocation { get; set; }
Property Value
Type Description
System.Boolean

Level

A notional indication of the level this entity is at within the structure of the path

Declaration
[Key]
[Column(Order = 4)]
short Level { get; set; }
Property Value
Type Description
System.Int16

PathID

The id of the allocation path used to calculate the total allocation percentages

Declaration
[Key]
[Column(Order = 0)]
Guid PathID { get; set; }
Property Value
Type Description
System.Guid

PathID_Label

The label fro the allocation path

Declaration
string PathID_Label { get; set; }
Property Value
Type Description
System.String

Pct

The default amount A percentage

Declaration
decimal Pct { get; set; }
Property Value
Type Description
System.Decimal

PctB

The alternative amount B percentage

Declaration
decimal PctB { get; set; }
Property Value
Type Description
System.Decimal

RootEntityID

The root entity that the percentage relates to

Declaration
Guid RootEntityID { get; set; }
Property Value
Type Description
System.Guid

RootEntityID_Label

The label for the root entity

Declaration
string RootEntityID_Label { get; set; }
Property Value
Type Description
System.String

RoundingToEntityID

The entity to be used for any rounding calculations

Declaration
Guid RoundingToEntityID { get; set; }
Property Value
Type Description
System.Guid

RoundingToEntityID_Label

The label for the entity that is used for rounding

Declaration
string RoundingToEntityID_Label { get; set; }
Property Value
Type Description
System.String

SourceEntityID

The id of the root entity in the allocation path this percentage is being allcoated from

Declaration
[Key]
[Column(Order = 2)]
Guid SourceEntityID { get; set; }
Property Value
Type Description
System.Guid

SourceEntityID_Label

The label for the source entity

Declaration
string SourceEntityID_Label { get; set; }
Property Value
Type Description
System.String

Timing

Indicates at what timing the allocation is effective from

Declaration
AllocationTiming Timing { get; set; }
Property Value
Type Description
AllocationTiming

ToEntityID

The ultimate owning entity from the percentage allocates to

Declaration
[Key]
[Column(Order = 3)]
Guid ToEntityID { get; set; }
Property Value
Type Description
System.Guid

ToEntityID_Label

The label for the to entity

Declaration
string ToEntityID_Label { get; set; }
Property Value
Type Description
System.String

TransferID

The id of a transfer that shows the movements in percentage due to a transfer

Declaration
[Key]
[Column(Order = 4)]
Guid TransferID { get; set; }
Property Value
Type Description
System.Guid

TransferID_Label

The label for any transfer

Declaration
string TransferID_Label { get; set; }
Property Value
Type Description
System.String

Extension Methods