package com.cm.inspection.service.publiclog;

import com.cm.common.exception.RemoveException;
import com.cm.common.exception.SaveException;
import com.cm.common.exception.SearchException;
import com.cm.common.pojo.ListPage;
import com.cm.common.result.SuccessResult;
import com.cm.common.result.SuccessResultData;
import com.cm.common.result.SuccessResultList;
import com.cm.inspection.pojo.dtos.publiclog.PublicLogDTO;
import com.cm.inspection.pojo.vos.publiclog.PublicLogVO;

import java.util.List;
import java.util.Map;

/**
 * @ClassName: IPublicLogService
 * @Description: 公共日志
 * @Author: WenG
 * @Date: 2020-04-26 17:42
 * @Version: 1.0
 **/
public interface IPublicLogService {

    /**
     * 新增公共日志
     *
     * @param publicLogVO
     * @return
     * @throws Exception
     */
    SuccessResult savePublicLog(PublicLogVO publicLogVO) throws Exception;

    /**
     * 新增公共日志(APP)
     *
     * @param token
     * @param publicLogVO
     * @return
     * @throws Exception
     */
    SuccessResult savePublicLogByToken(String token, PublicLogVO publicLogVO) throws Exception;

    /**
     * 快捷保存公共日志
     *
     * @param token
     * @param publicAreaReportId
     * @param publicLeaderHandleId
     * @param summary
     * @param userName
     * @throws Exception
     */
    void savePublicLogSimple(String token, String publicAreaReportId, String publicLeaderHandleId, String summary, String userName) throws Exception;

    /**
     * 删除公共日志
     *
     * @param ids
     * @return
     * @throws RemoveException
     */
    SuccessResult removePublicLog(String ids) throws RemoveException;

    /**
     * 删除公共日志（物理删除）
     *
     * @param ids
     * @throws RemoveException
     */
    void deletePublicLog(String ids) throws RemoveException;

    /**
     * 删除公共日志(APP)
     *
     * @param token
     * @param ids
     * @return
     * @throws RemoveException
     */
    SuccessResult removePublicLogByToken(String token, String ids) throws RemoveException;

    /**
     * 修改公共日志
     *
     * @param publicLogId
     * @param publicLogVO
     * @return
     * @throws Exception
     */
    SuccessResult updatePublicLog(String publicLogId, PublicLogVO publicLogVO) throws Exception;

    /**
     * 修改公共日志(APP)
     *
     * @param token
     * @param publicLogId
     * @param publicLogVO
     * @return
     * @throws Exception
     */
    SuccessResult updatePublicLogByToken(String token, String publicLogId, PublicLogVO publicLogVO) throws Exception;

    /**
     * 公共日志详情(通过ID)
     *
     * @param publicLogId
     * @return
     * @throws SearchException
     */
    PublicLogDTO getPublicLogById(String publicLogId) throws SearchException;

    /**
     * 公共日志列表
     *
     * @param params
     * @return
     * @throws SearchException
     */
    List<PublicLogDTO> listPublicLog(Map<String, Object> params) throws SearchException;

    /**
     * 公共日志分页列表
     *
     * @param page
     * @return
     * @throws SearchException
     */
    SuccessResultList<List<PublicLogDTO>> listPagePublicLog(ListPage page) throws SearchException;

    /**
     * 公共日志统计
     *
     * @param params
     * @return
     * @throws SearchException
     */
    Integer countNumberPublicLog(Map<String, Object> params) throws SearchException;

    /**
     * 公共日志统计
     *
     * @param params
     * @return
     * @throws SearchException
     */
    SuccessResultData<Integer> countPublicLog(Map<String, Object> params) throws SearchException;

}