package cn.iocoder.yudao.module.archive.api.document;

import cn.iocoder.yudao.framework.common.pojo.CommonResult;
import cn.iocoder.yudao.module.archive.api.document.dto.ArchiveDocumentCreateReqDTO;
import cn.iocoder.yudao.module.archive.api.document.dto.ArchiveDocumentRespDTO;

/**
 * 档案归档 API 接口
 *
 * 供其他模块（课题/会员/财务）按来源单据归档，生成档案条目并带入来源附件。
 *
 * @author 超级管理员
 */
public interface ArchiveDocumentApi {

    String PREFIX = "/rpc-api/archive/document";

    /**
     * 按来源单据归档；幂等：同 sourceType + sourceId 已归档则返回既有档案编号
     *
     * @param reqDTO 归档信息
     * @return 档案编号
     */
    CommonResult<Long> archiveBySource(ArchiveDocumentCreateReqDTO reqDTO);

    /**
     * 判断来源单据是否已归档
     *
     * @param sourceType 来源类型
     * @param sourceId   来源单据编号
     * @return 是否已归档
     */
    CommonResult<Boolean> isArchived(Integer sourceType, Long sourceId);

    /**
     * 获取来源单据的档案
     *
     * @param sourceType 来源类型
     * @param sourceId   来源单据编号
     * @return 档案
     */
    CommonResult<ArchiveDocumentRespDTO> getBySource(Integer sourceType, Long sourceId);

}