package com.yolo.keyboard.service.aicompanion;

import com.yolo.keyboard.controller.admin.aicompanion.vo.KeyboardAiCompanionPageReqVO;
import com.yolo.keyboard.controller.admin.aicompanion.vo.KeyboardAiCompanionSaveReqVO;
import com.yolo.keyboard.dal.dataobject.aicompanion.AiCompanionI18nDO;
import com.yolo.keyboard.dal.dataobject.aicompanion.KeyboardAiCompanionDO;
import com.yolo.keyboard.framework.common.pojo.PageParam;
import com.yolo.keyboard.framework.common.pojo.PageResult;
import jakarta.validation.Valid;

import java.util.List;

/**
 * AI陪聊角色表，用于定义恋爱/陪伴型虚拟角色的基础信息与人设 Service 接口
 *
 * @author ziin
 */
public interface KeyboardAiCompanionService {

    /**
     * 创建AI陪聊角色表，用于定义恋爱/陪伴型虚拟角色的基础信息与人设
     *
     * @param createReqVO 创建信息
     * @return 编号
     */
    Long createAiCompanion(@Valid KeyboardAiCompanionSaveReqVO createReqVO);

    /**
     * 更新AI陪聊角色表，用于定义恋爱/陪伴型虚拟角色的基础信息与人设
     *
     * @param updateReqVO 更新信息
     */
    void updateAiCompanion(@Valid KeyboardAiCompanionSaveReqVO updateReqVO);

    /**
     * 删除AI陪聊角色表，用于定义恋爱/陪伴型虚拟角色的基础信息与人设
     *
     * @param id 编号
     */
    void deleteAiCompanion(Long id);

    /**
    * 批量删除AI陪聊角色表，用于定义恋爱/陪伴型虚拟角色的基础信息与人设
    *
    * @param ids 编号
    */
    void deleteAiCompanionListByIds(List<Long> ids);

    /**
     * 获得AI陪聊角色表，用于定义恋爱/陪伴型虚拟角色的基础信息与人设
     *
     * @param id 编号
     * @return AI陪聊角色表，用于定义恋爱/陪伴型虚拟角色的基础信息与人设
     */
    KeyboardAiCompanionDO getAiCompanion(Long id);

    /**
     * 获得AI陪聊角色表，用于定义恋爱/陪伴型虚拟角色的基础信息与人设分页
     *
     * @param pageReqVO 分页查询
     * @return AI陪聊角色表，用于定义恋爱/陪伴型虚拟角色的基础信息与人设分页
     */
    PageResult<KeyboardAiCompanionDO> getAiCompanionPage(KeyboardAiCompanionPageReqVO pageReqVO);
    // ==================== 子表（AI陪聊角色国际化表，用于存储不同语言下的角色名称、一句话描述和详细介绍） ====================

    /**
     * 获得AI陪聊角色国际化表，用于存储不同语言下的角色名称、一句话描述和详细介绍分页
     *
     * @param pageReqVO 分页查询
     * @param id 主键ID
     * @return AI陪聊角色国际化表，用于存储不同语言下的角色名称、一句话描述和详细介绍分页
     */
    PageResult<AiCompanionI18nDO> getAiCompanionI18nPage(PageParam pageReqVO, Long id);

    /**
     * 创建AI陪聊角色国际化表，用于存储不同语言下的角色名称、一句话描述和详细介绍
     *
     * @param aiCompanionI18n 创建信息
     * @return 编号
     */
    Long createAiCompanionI18n(@Valid AiCompanionI18nDO aiCompanionI18n);

    /**
     * 更新AI陪聊角色国际化表，用于存储不同语言下的角色名称、一句话描述和详细介绍
     *
     * @param aiCompanionI18n 更新信息
     */
    void updateAiCompanionI18n(@Valid AiCompanionI18nDO aiCompanionI18n);

    /**
     * 删除AI陪聊角色国际化表，用于存储不同语言下的角色名称、一句话描述和详细介绍
     *
     * @param id 编号
     */
    void deleteAiCompanionI18n(Long id);

    /**
     * 批量删除AI陪聊角色国际化表，用于存储不同语言下的角色名称、一句话描述和详细介绍
     *
     * @param ids 编号
     */
    void deleteAiCompanionI18nListByIds(List<Long> ids);

    /**
     * 获得AI陪聊角色国际化表，用于存储不同语言下的角色名称、一句话描述和详细介绍
     *
     * @param id 编号
     * @return AI陪聊角色国际化表，用于存储不同语言下的角色名称、一句话描述和详细介绍
     */
    AiCompanionI18nDO getAiCompanionI18n(Long id);
}