src/main/java/com/carpooling/dao/base/RouteDao.java - master - Buka/CarPooling

src/main/java/com/carpooling/dao/base/RouteDao.java

46 строк2 KB

BUka228

После рефакторинга пакетов

18 янв 2025, 17:08

18 янв 2025, 17:08a4d4c33

package com.carpooling.dao.base;

import com.carpooling.entities.database.Route;
import com.carpooling.entities.record.RouteRecord;
import com.carpooling.exceptions.dao.DataAccessException;

import java.util.Optional;

/**
 * DAO интерфейс для работы с маршрутами.
 */
public interface RouteDao {
    /**
     * Создает новый маршрут в базе данных.
     *
     * @param routeRecord объект {@link Route}, содержащий информацию о маршруте.
     * @return {@link Optional} с ID созданного маршрута, или {@link Optional#empty()} в случае неудачи.
     * @throws DataAccessException если произошла ошибка при создании маршрута.
     */
    String createRoute(RouteRecord routeRecord) throws DataAccessException;

    /**
     * Получает маршрут из базы данных по его ID.
     *
     * @param id уникальный идентификатор маршрута.
     * @return {@link Optional} с объектом {@link Route}, или {@link Optional#empty()} если маршрут не найден.
     * @throws DataAccessException если маршрут не найден.
     */
    Optional<RouteRecord> getRouteById(String id) throws DataAccessException;

    /**
     * Обновляет информацию о маршруте в базе данных.
     *
     * @param routeRecord объект {@link Route} с обновленной информацией.
     * @throws DataAccessException если произошла ошибка при обновлении маршрута.
     */
    void updateRoute(RouteRecord routeRecord) throws DataAccessException;

    /**
     * Удаляет маршрут из базы данных по его ID.
     *
     * @param id уникальный идентификатор маршрута.
     * @throws DataAccessException если маршрут не найден.
     */
    void deleteRoute(String id) throws DataAccessException;
}