persistence/DD.Persistence.Client/Clients/Interfaces/IChangeLogClient.cs

using DD.Persistence.Models.ChangeLog;
using DD.Persistence.Models.Common;
using DD.Persistence.Models.Requests;

namespace DD.Persistence.Client.Clients.Interfaces;

/// <summary>
/// Клиент для работы с записями ChangeLog
/// </summary>
public interface IChangeLogClient : IDisposable
{
    /// <summary>
    /// Добавить несколько записей
    /// </summary>
    /// <param name="idDiscriminator"></param>
    /// <param name="dtos"></param>
    /// <param name="comment"></param>
    /// <param name="token"></param>
    /// <returns></returns>
    Task<int> AddRange(Guid idDiscriminator, IEnumerable<ChangeLogCreateRequest> dtos, string comment, CancellationToken token);

    /// <summary>
    /// Импорт с заменой: удаление старых строк и добавление новых
    /// </summary>
    /// <param name="idDiscriminator"></param>
    /// <param name="dtos"></param>
    /// <param name="comment"></param>
    /// <param name="token"></param>
    /// <returns></returns>
    Task<int> ClearAndAddRange(Guid idDiscriminator, IEnumerable<ChangeLogCreateRequest> dtos, string comment, CancellationToken token);

    /// <summary>
    /// Удалить несколько записей
    /// </summary>
    /// <param name="idDiscriminator"></param>
    /// <param name="ids"></param>
    /// <param name="comment"></param>
    /// <param name="token"></param>
    /// <returns></returns>
    Task<int> DeleteRange(Guid idDiscriminator, IEnumerable<Guid> ids, string comment, CancellationToken token);

	/// <summary>
	/// Получение актуальных данных на определенную дату (с пагинацией)
	/// </summary>
	/// <param name="idDiscriminator"></param>
	/// <param name="moment"></param>
	/// <param name="paginationRequest"></param>
	/// <param name="token"></param>
	/// <returns></returns>
	Task<PaginationContainer<ChangeLogBaseDto>> 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<DatesRangeDto?> GetDatesRange(Guid idDiscriminator, CancellationToken token);

    /// <summary>
    /// Обновить несколько записей
    /// </summary>
    /// <param name="idDiscriminator"></param>
    /// <param name="dtos"></param>
    /// <param name="comment"></param>
    /// <param name="token"></param>
    /// <returns></returns>
    Task<int> UpdateRange(Guid idDiscriminator, IEnumerable<ChangeLogBaseDto> dtos, string comment, CancellationToken token);

    /// <summary>
    /// Получение статистики журнала изменений 
    /// </summary>
    /// <param name="request"></param>
    /// <param name="token"></param>
    /// <returns></returns>
    Task<IEnumerable<ChangeLogStatisticsDto>> GetStatistics(ChangeLogQuery request, CancellationToken token);

    /// <summary>
    /// Получение истории по журналу изменений 
    /// </summary>
    /// <param name="request"></param>
    /// <param name="token"></param>
    /// <returns></returns>
    Task<IEnumerable<ChangeLogCommitDto>> GetHistory(ChangeLogQuery request, CancellationToken token);
}