persistence/DD.Persistence/Repositories/IChangeLogRepository.cs

using DD.Persistence.Models;
using DD.Persistence.Models.Common;
using DD.Persistence.Models.Requests;
using Microsoft.EntityFrameworkCore.Storage.ValueConversion.Internal;

namespace DD.Persistence.Repositories;

/// <summary>
/// Интерфейс для работы с историческими данными
/// </summary>
public interface IChangeLogRepository : ISyncWithDiscriminatorRepository<ChangeLogValuesDto>
{
    /// <summary>
    /// Добавление записей
    /// </summary>
    /// <param name="idDiscriminator">ключ справочника</param>
    /// <param name="dto">коммит с изменениями</param>
    /// <param name="token"></param>
    /// <returns></returns>
    Task<int> AddRange(Guid idDiscriminator, ChangeLogCommitDto dto, CancellationToken token);

    /// <summary>
    /// Пометить записи как удаленные
    /// </summary>
    /// <param name="idCommit"></param>
    /// <param name="ids">ключи записей</param>
    /// <param name="updateTime"></param>
    /// <param name="token"></param>
    /// <returns></returns>
    Task<int> MarkAsDeleted(Guid idCommit, IEnumerable<Guid> ids, DateTimeOffset updateTime, CancellationToken token);

    /// <summary>
    /// Пометить записи как удаленные
    /// </summary>
    /// <param name="idDiscriminator">дискриминатор таблицы</param>
    /// <param name="idCommit"></param>
    /// <param name="updateTime"></param>
    /// <param name="token"></param>
    /// <returns></returns>
    Task<int> MarkAsDeleted(Guid idDiscriminator, Guid idCommit, DateTimeOffset updateTime, CancellationToken token);

    /// <summary>
    /// Очистить и добавить новые
    /// </summary>
    /// <param name="idDiscriminator"></param>
    /// <param name="commitDto">коммит с изменениями</param>
    /// <param name="token"></param>
    /// <returns></returns>
    Task<int> ClearAndAddRange(Guid idDiscriminator, ChangeLogCommitDto commitDto, CancellationToken token);

    /// <summary>
    /// Редактирование записей
    /// </summary>
    /// <param name="commitDto">коммит с изменениями</param>
    /// <param name="token"></param>
    /// <returns></returns>
    Task<int> UpdateRange(ChangeLogCommitDto commitDto, CancellationToken token);

    /// <summary>
    /// Получение актуальных записей на определенный момент времени (с пагинацией)
    /// </summary>
    /// <param name="idDiscriminator"></param>
    /// <param name="moment">текущий момент времени</param>
    /// <param name="paginationRequest">параметры запроса пагинации</param>
    /// <param name="token"></param>
    /// <returns></returns>
    Task<PaginationContainer<ChangeLogValuesDto>> GetByDate(Guid idDiscriminator, DateTimeOffset moment, PaginationRequest paginationRequest, CancellationToken token);

    /// <summary>
    /// Получение измененных записей за период времени
    /// </summary>
    /// <param name="idDiscriminator"></param>
    /// <param name="dateBegin"></param>
    /// <param name="dateEnd"></param>
    /// <param name="token"></param>
    /// <returns></returns>
    Task<IEnumerable<ChangeLogDto>> GetChangeLogForInterval(Guid idDiscriminator, DateTimeOffset dateBegin, DateTimeOffset dateEnd, CancellationToken token);

    /// <summary>
    /// Получение списка дат, в которые происходили изменения (день, месяц, год, без времени)
    /// </summary>
    /// <param name="idDiscriminator"></param>
    /// <param name="token"></param>
    /// <returns></returns>
    Task<IEnumerable<DateOnly>> GetDatesChange(Guid idDiscriminator, CancellationToken token);
}