IGroupAppService.cs 2.18 KB
using FoodLabeling.Application.Contracts.Dtos.Common;
using FoodLabeling.Application.Contracts.Dtos.Group;
using Microsoft.AspNetCore.Mvc;
using Volo.Abp.Application.Dtos;
using Volo.Abp.Application.Services;

namespace FoodLabeling.Application.Contracts.IServices;

/// <summary>
/// 组织(Group)管理接口(fl_group)
/// </summary>
public interface IGroupAppService : IApplicationService
{
    /// <summary>
    /// 组织分页列表(与导出使用相同筛选条件)
    /// </summary>
    /// <remarks>
    /// 数据范围(按登录 Token):
    /// 管理员可见全部 Region;其它角色仅可见其 <c>userlocation</c> 绑定门店对应的组织(<c>location.Partner</c> + <c>location.GroupName</c> 与 <c>fl_group</c> 匹配)。
    /// </remarks>
    /// <param name="input">分页与筛选;SkipCount 为页码(从 1 起)</param>
    Task<PagedResultWithPageDto<GroupGetListOutputDto>> GetListAsync(GroupGetListInputVo input);

    /// <summary>
    /// 组织详情
    /// </summary>
    /// <param name="id">主键(Guid,与 <c>fl_group.Id</c> 一致;约定路由 <c>{id:guid}</c>,避免与 <c>export-pdf</c> 等路径冲突)</param>
    Task<GroupGetOutputDto> GetAsync(Guid id);

    /// <summary>
    /// 新增组织
    /// </summary>
    Task<GroupGetOutputDto> CreateAsync(GroupCreateInputVo input);

    /// <summary>
    /// 编辑组织
    /// </summary>
    Task<GroupGetOutputDto> UpdateAsync(Guid id, GroupUpdateInputVo input);

    /// <summary>
    /// 删除组织(逻辑删除)
    /// </summary>
    Task DeleteAsync(Guid id);

    /// <summary>
    /// 按列表相同筛选条件全量导出组织(Region)为 PDF(不分页;与 <see cref="GetListAsync"/> 相同筛选与 Token 数据范围;单次最多 5000 条)
    /// </summary>
    /// <remarks>
    /// 与 <see cref="GetListAsync"/> 使用同一套 <c>BuildGroupJoinedQueryAsync</c>(含 <c>ResolveGroupScopeAsync</c>),导出行集与列表一致。
    /// </remarks>
    /// <param name="input">Keyword、PartnerId、State、Sorting;分页字段忽略</param>
    /// <returns>application/pdf</returns>
    Task<IActionResult> ExportPdfAsync(GroupGetListInputVo input);
}