DD.WellWorkover.Cloud/AsbCloudApp/Services/ICrudService.cs

78 lines
2.8 KiB
C#
Raw Normal View History

2022-06-01 17:52:26 +05:00
using System;
using System.Collections.Generic;
2021-08-10 14:35:49 +05:00
using System.Threading;
using System.Threading.Tasks;
2021-08-02 14:45:13 +05:00
namespace AsbCloudApp.Services
{
2022-06-01 17:52:26 +05:00
#nullable enable
2022-06-01 17:52:26 +05:00
/// <summary>
/// Сервис получения, добавления, изменения, удаления данных
/// </summary>
/// <typeparam name="Tdto"></typeparam>
2021-08-02 14:45:13 +05:00
public interface ICrudService<Tdto>
where Tdto : Data.IId
{
2022-06-01 17:52:26 +05:00
/// <summary>
/// Код возврата ошибки: Id не найден в БД.
2022-06-01 17:52:26 +05:00
/// </summary>
public const int ErrorIdNotFound = -1;
2022-06-01 17:52:26 +05:00
/// <summary>
/// Получение всех записей
2022-06-01 17:52:26 +05:00
/// </summary>
/// <param name="token"></param>
/// <returns>emptyList if nothing found</returns>
Task<IEnumerable<Tdto>> GetAllAsync(CancellationToken token);
2022-06-01 17:52:26 +05:00
/// <summary>
/// Получить запись по id
2022-06-01 17:52:26 +05:00
/// </summary>
/// <param name="id"></param>
2022-06-01 17:52:26 +05:00
/// <param name="token"></param>
/// <returns>null if not found</returns>
Task<Tdto?> GetAsync(int id, CancellationToken token);
2022-06-01 17:52:26 +05:00
/// <summary>
/// Получить запись по id
2022-06-01 17:52:26 +05:00
/// </summary>
/// <param name="id"></param>
/// <returns>null if not found</returns>
Tdto? Get(int id);
/// <summary>
/// Добавление новой записи
/// </summary>
/// <param name="newItem"></param>
2022-06-01 17:52:26 +05:00
/// <param name="token"></param>
/// <returns>Id новой записи</returns>
Task<int> InsertAsync(Tdto newItem, CancellationToken token);
2022-06-01 17:52:26 +05:00
/// <summary>
/// Добавление нескольких записей
2022-06-01 17:52:26 +05:00
/// </summary>
/// <param name="newItems"></param>
2022-06-01 17:52:26 +05:00
/// <param name="token"></param>
/// <returns>количество добавленных</returns>
Task<int> InsertRangeAsync(IEnumerable<Tdto> newItems, CancellationToken token);
2022-06-01 17:52:26 +05:00
/// <summary>
/// Отредактировать запись
/// </summary>
/// <param name="id"></param>
/// <param name="item"></param>
/// <param name="token"></param>
/// <returns>если больше 0 - Id записи, если меньше 0 - код ошибки</returns>
Task<int> UpdateAsync(int id, Tdto item, CancellationToken token);
2022-06-01 17:52:26 +05:00
/// <summary>
/// Удалить запись
/// </summary>
/// <param name="id"></param>
/// <param name="token"></param>
/// <returns>если больше 0 - Id записи, если меньше 0 - код ошибки</returns>
Task<int> DeleteAsync(int id, CancellationToken token);
2021-08-02 14:45:13 +05:00
}
2022-06-01 17:52:26 +05:00
#nullable disable
2021-08-02 14:45:13 +05:00
}