Class FinancialDateCalculator

A helper class responsible for retrieving, and caching, the financial date to use for a given date taking into account entity IEntityPeriodClosing

Inheritance

object

FinancialDateCalculator

Implements

IFinancialDateCalculator

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: LemonEdge.API.Core.FinancialServices.Processors

Assembly: LemonEdge.API.Core.FinancialServices.dll

Syntax

public class FinancialDateCalculator : IFinancialDateCalculator

Constructors

FinancialDateCalculator(IReadOnlyCache)

Creates a new financial date calculator using the specified retriever

Declaration

public FinancialDateCalculator(IReadOnlyCache cache)

Parameters

Type	Name	Description
IReadOnlyCache	cache

Methods

GetFinancialDate(Guid, DateTime)

Retrieves a valid financial date for the specified entity id and transaction date

If the given entity has no IEntityPeriodClosing associated with it then this returns the transactionDate

If a period closing exists that is greater or equal to the transactionDate then the returned date is one day after the latest period closing for that entity. In other words the next available open data for that entity.

Declaration

public Task<DateTime> GetFinancialDate(Guid entityID, DateTime transactionDate)

Parameters

Type	Name	Description
Guid	entityID	The entity to retrieve a valid financial date for
DateTime	transactionDate	The transaction date that we need to retrieve a financial date for

Returns

Type	Description
Task<DateTime>	A valid open financial date for the given entity and date

GetFinancialDate(Guid, DateTime, DateTimeOffset?)

Retrieves a valid financial date for the specified entity id and transaction date

If the given entity has no IEntityPeriodClosing associated with it then this returns the transactionDate unless the provided matchFinancialDateIfPrior is greater in which case that is returned

If a period closing exists that is greater or equal to the transactionDate then the returned date is one day after the latest period closing for that entity. In other words the next available open data for that entity.

Declaration

public Task<DateTime> GetFinancialDate(Guid entityID, DateTime transactionDate, DateTimeOffset? matchFinancialDateIfPrior)

Parameters

Type	Name	Description
Guid	entityID	The entity to retrieve a valid financial date for
DateTime	transactionDate	The transaction date that we need to retrieve a financial date for
DateTimeOffset?	matchFinancialDateIfPrior	If null then and there are no period closings then the transactionDate is returned, otherwise this date is returned if it is greater than the transaction date. In other words it keeps this current financial date, and does not reset it back to a lower transaction date

Returns

Type	Description
Task<DateTime>	A valid open financial date for the given entity and date

GetFinancialDate(Guid, DateTime, DateTime?)

Retrieves a valid financial date for the specified entity id and transaction date

If the given entity has no IEntityPeriodClosing associated with it then this returns the transactionDate unless the provided matchFinancialDateIfPrior is greater in which case that is returned

If a period closing exists that is greater or equal to the transactionDate then the returned date is one day after the latest period closing for that entity. In other words the next available open data for that entity.

Declaration

public Task<DateTime> GetFinancialDate(Guid entityID, DateTime transactionDate, DateTime? matchFinancialDateIfPrior)

Parameters

Type	Name	Description
Guid	entityID	The entity to retrieve a valid financial date for
DateTime	transactionDate	The transaction date that we need to retrieve a financial date for
DateTime?	matchFinancialDateIfPrior	If null then and there are no period closings then the transactionDate is returned, otherwise this date is returned if it is greater than the transaction date. In other words it keeps this current financial date, and does not reset it back to a lower transaction date

Returns

Type	Description
Task<DateTime>	A valid open financial date for the given entity and date

Implements

IFinancialDateCalculator

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)