/*
 * Copyright (c) 2023 - present Dromara, All rights reserved.
 *
 *   https://visor.dromara.org
 *   https://visor.dromara.org.cn
 *   https://visor.orionsec.cn
 *
 * Members:
 *   Jiahang Li - ljh1553488six@139.com - author
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.dromara.visor.module.infra.api;

import org.dromara.visor.module.infra.enums.FavoriteTypeEnum;

import java.util.List;
import java.util.concurrent.Future;

/**
 * 收藏 对外服务类
 *
 * @author Jiahang Li
 * @version 1.0.0
 * @since 2023-9-1 10:30
 */
public interface FavoriteApi {

    /**
     * 获取收藏 relId 列表 会有已删除的 id
     *
     * @param type   type
     * @param userId userId
     * @return relIdList
     */
    List<Long> getFavoriteRelIdList(FavoriteTypeEnum type, Long userId);

    /**
     * 异步查询用户收藏
     *
     * @param type   type
     * @param userId userId
     * @return relIdList
     */
    Future<List<Long>> getFavoriteRelIdListAsync(FavoriteTypeEnum type, Long userId);

    /**
     * 通过 relId 删除收藏
     *
     * @param type  type
     * @param relId relId
     */
    void deleteByRelId(FavoriteTypeEnum type, Long relId);

    /**
     * 通过 relId 删除收藏
     *
     * @param type      type
     * @param relIdList relIdList
     */
    void deleteByRelIdList(FavoriteTypeEnum type, List<Long> relIdList);

}
