package com.iailab.module.bpm.service.task;

import com.iailab.framework.common.pojo.PageResult;
import com.iailab.module.bpm.api.task.dto.BpmProcessInstanceCreateReqDTO;
import com.iailab.module.bpm.controller.admin.task.vo.instance.*;
import org.flowable.engine.history.HistoricProcessInstance;
import org.flowable.engine.runtime.ProcessInstance;

import javax.validation.Valid;
import java.util.List;
import java.util.Map;
import java.util.Set;

import static com.iailab.framework.common.util.collection.CollectionUtils.convertMap;

/**
 * æµç¨‹å®žä¾‹ Service æŽ¥å£
 *
 * @author èŠ‹é“æºç 
 */
public interface BpmProcessInstanceService {

    // ========== Query æŸ¥è¯¢ç›¸å…³æ–¹æ³• ==========

    /**
     * èŽ·å¾—æµç¨‹å®žä¾‹
     *
     * @param id æµç¨‹å®žä¾‹çš„ç¼–å·
     * @return æµç¨‹å®žä¾‹
     */
    ProcessInstance getProcessInstance(String id);

    /**
     * èŽ·å¾—æµç¨‹å®žä¾‹åˆ—è¡¨
     *
     * @param ids æµç¨‹å®žä¾‹çš„ç¼–å·é›†åˆ
     * @return æµç¨‹å®žä¾‹åˆ—è¡¨
     */
    List<ProcessInstance> getProcessInstances(Set<String> ids);

    /**
     * èŽ·å¾—æµç¨‹å®žä¾‹ Map
     *
     * @param ids æµç¨‹å®žä¾‹çš„ç¼–å·é›†åˆ
     * @return æµç¨‹å®žä¾‹åˆ—è¡¨ Map
     */
    default Map<String, ProcessInstance> getProcessInstanceMap(Set<String> ids) {
        return convertMap(getProcessInstances(ids), ProcessInstance::getProcessInstanceId);
    }

    /**
     * èŽ·å¾—åŽ†å²çš„æµç¨‹å®žä¾‹
     *
     * @param id æµç¨‹å®žä¾‹çš„ç¼–å·
     * @return åŽ†å²çš„æµç¨‹å®žä¾‹
     */
    HistoricProcessInstance getHistoricProcessInstance(String id);

    /**
     * èŽ·å¾—åŽ†å²çš„æµç¨‹å®žä¾‹åˆ—è¡¨
     *
     * @param ids æµç¨‹å®žä¾‹çš„ç¼–å·é›†åˆ
     * @return åŽ†å²çš„æµç¨‹å®žä¾‹åˆ—è¡¨
     */
    List<HistoricProcessInstance> getHistoricProcessInstances(Set<String> ids);

    /**
     * èŽ·å¾—åŽ†å²çš„æµç¨‹å®žä¾‹ Map
     *
     * @param ids æµç¨‹å®žä¾‹çš„ç¼–å·é›†åˆ
     * @return åŽ†å²çš„æµç¨‹å®žä¾‹åˆ—è¡¨ Map
     */
    default Map<String, HistoricProcessInstance> getHistoricProcessInstanceMap(Set<String> ids) {
        return convertMap(getHistoricProcessInstances(ids), HistoricProcessInstance::getId);
    }

    /**
     * èŽ·å¾—æµç¨‹å®žä¾‹çš„åˆ†é¡µ
     *
     * @param userId    ç”¨æˆ·ç¼–å·
     * @param pageReqVO åˆ†é¡µè¯·æ±‚
     * @return æµç¨‹å®žä¾‹çš„åˆ†é¡µ
     */
    PageResult<HistoricProcessInstance> getProcessInstancePage(Long userId,
                                                               @Valid BpmProcessInstancePageReqVO pageReqVO);

    // TODO @èŠ‹è‰¿ï¼šé‡ç‚¹åœ¨ review ä¸‹
    /**
     * èŽ·å–å®¡æ‰¹è¯¦æƒ…ã€‚
     * <p>
     * å¯ä»¥æ˜¯å‡†å¤‡å‘èµ·çš„æµç¨‹ã€è¿›è¡Œä¸çš„æµç¨‹ã€å·²ç»ç»“æŸçš„æµç¨‹
     *
     * @param loginUserId  ç™»å½•äººçš„ç”¨æˆ·ç¼–å·
     * @param reqVO è¯·æ±‚ä¿¡æ¯
     * @return æµç¨‹å®žä¾‹çš„è¿›åº¦
     */
    BpmApprovalDetailRespVO getApprovalDetail(Long loginUserId, @Valid BpmApprovalDetailReqVO reqVO);

    /**
     * èŽ·å–æµç¨‹å®žä¾‹çš„ BPMN æ¨¡åž‹è§†å›¾
     *
     * @param id æµç¨‹å®žä¾‹çš„ç¼–å·
     * @return BPMN æ¨¡åž‹è§†å›¾
     */
    BpmProcessInstanceBpmnModelViewRespVO getProcessInstanceBpmnModelView(String id);

    // ========== Update å†™å…¥ç›¸å…³æ–¹æ³• ==========

    /**
     * åˆ›å»ºæµç¨‹å®žä¾‹ï¼ˆæä¾›ç»™å‰ç«¯ï¼‰
     *
     * @param userId      ç”¨æˆ·ç¼–å·
     * @param createReqVO åˆ›å»ºä¿¡æ¯
     * @return å®žä¾‹çš„ç¼–å·
     */
    String createProcessInstance(Long userId, @Valid BpmProcessInstanceCreateReqVO createReqVO);

    /**
     * åˆ›å»ºæµç¨‹å®žä¾‹ï¼ˆæä¾›ç»™å†…éƒ¨ï¼‰
     *
     * @param userId       ç”¨æˆ·ç¼–å·
     * @param createReqDTO åˆ›å»ºä¿¡æ¯
     * @return å®žä¾‹çš„ç¼–å·
     */
    String createProcessInstance(Long userId, @Valid BpmProcessInstanceCreateReqDTO createReqDTO);

    /**
     * å‘èµ·äººå–æ¶ˆæµç¨‹å®žä¾‹
     *
     * @param userId      ç”¨æˆ·ç¼–å·
     * @param cancelReqVO å–æ¶ˆä¿¡æ¯
     */
    void cancelProcessInstanceByStartUser(Long userId, @Valid BpmProcessInstanceCancelReqVO cancelReqVO);

    /**
     * ç®¡ç†å‘˜å–æ¶ˆæµç¨‹å®žä¾‹
     *
     * @param userId      ç”¨æˆ·ç¼–å·
     * @param cancelReqVO å–æ¶ˆä¿¡æ¯
     */
    void cancelProcessInstanceByAdmin(Long userId, BpmProcessInstanceCancelReqVO cancelReqVO);

    /**
     * æ›´æ–° ProcessInstance ä¸ºä¸é€šè¿‡
     *
     * @param processInstance æµç¨‹å®žä¾‹
     * @param reason          ç†ç”±ã€‚ä¾‹å¦‚è¯´ï¼Œå®¡æ‰¹ä¸é€šè¿‡æ—¶ï¼Œéœ€è¦ä¼ é€’è¯¥å€¼
     */
    void updateProcessInstanceReject(ProcessInstance processInstance, String reason);

    // ========== Event äº‹ä»¶ç›¸å…³æ–¹æ³• ==========

    /**
     * å¤„ç† ProcessInstance å®Œæˆäº‹ä»¶ï¼Œä¾‹å¦‚è¯´ï¼šå®¡æ‰¹é€šè¿‡ã€ä¸é€šè¿‡ã€å–æ¶ˆ
     *
     * @param instance æµç¨‹ä»»åŠ¡
     */
    void processProcessInstanceCompleted(ProcessInstance instance);

}