src/main/java/com/carpooling/services/base/RatingService.java - master - Buka/CarPooling

src/main/java/com/carpooling/services/base/RatingService.java
85 строк3 KB
BUka228
После рефакторинга пакетов
18 янв 2025, 17:08
18 янв 2025, 17:08a4d4c33
package com.carpooling.services.base;

import com.carpooling.entities.database.Rating;
import com.carpooling.exceptions.service.RatingServiceException;

import java.util.List;
import java.util.Optional;

/**
 * Интерфейс для работы с оценками.
 * Предоставляет методы для создания, получения, обновления и удаления оценок.
 */
public interface RatingService {

    /**
     * Создание новой оценки.
     *
     * @param rating Оценка для создания.
     * @param tripId ID поездки, к которой относится оценка.
     * @return ID созданной оценки.
     * @throws RatingServiceException Если произошла ошибка при создании.
     */
    String createRating(Rating rating, String tripId) throws RatingServiceException;

    /**
     * Получение оценки по ID.
     *
     * @param ratingId ID оценки.
     * @return Оценка, если найдена.
     * @throws RatingServiceException Если оценка не найдена или произошла ошибка.
     */
    Optional<Rating> getRatingById(String ratingId) throws RatingServiceException;

    /**
     * Получение всех оценок.
     *
     * @return Список всех оценок.
     * @throws RatingServiceException Если произошла ошибка при получении.
     */
    List<Rating> getAllRatings() throws RatingServiceException;

    /**
     * Обновление данных оценки.
     *
     * @param rating Оценка с обновленными данными.
     * @param tripId ID поездки, к которой относится оценка.
     * @throws RatingServiceException Если произошла ошибка при обновлении.
     */
    void updateRating(Rating rating, String tripId) throws RatingServiceException;

    /**
     * Удаление оценки по ID.
     *
     * @param ratingId ID оценки.
     * @throws RatingServiceException Если произошла ошибка при удалении.
     */
    void deleteRating(String ratingId) throws RatingServiceException;

    /**
     * Получение оценок по ID поездки.
     *
     * @param tripId ID поездки.
     * @return Список оценок для указанной поездки.
     * @throws RatingServiceException Если произошла ошибка при получении.
     */
    List<Rating> getRatingsByTrip(String tripId) throws RatingServiceException;

    /**
     * Получение оценок по рейтингу.
     *
     * @param rating Рейтинг оценки.
     * @return Список оценок с указанным рейтингом.
     * @throws RatingServiceException Если произошла ошибка при получении.
     */
    List<Rating> getRatingsByRating(int rating) throws RatingServiceException;

    /**
     * Получение средней оценки поездки.
     *
     * @param tripId ID поездки.
     * @return Средний рейтинг поездки.
     * @throws RatingServiceException Если произошла ошибка при расчете.
     */
    double getAverageRatingForTrip(String tripId) throws RatingServiceException;
}