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

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

45 строк2 KB

BUka228

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

18 янв 2025, 17:08

18 янв 2025, 17:08a4d4c33

package com.carpooling.dao.base;

import com.carpooling.entities.record.UserRecord;
import com.carpooling.exceptions.dao.DataAccessException;

import java.util.Optional;

/**
 * Интерфейс для работы с пользователями в базе данных.
 */
public interface UserDao {
    /**
     * Создает нового пользователя в базе данных.
     *
     * @param userRecord Объект пользователя, который нужно создать.
     * @return ID созданного пользователя.
     * @throws DataAccessException Если произошла ошибка при создании пользователя.
     */
    String createUser(UserRecord userRecord) throws DataAccessException;

    /**
     * Возвращает пользователя по его ID.
     *
     * @param id ID пользователя.
     * @return Optional, содержащий пользователя, если он найден, или пустой Optional, если пользователь не найден.
     * @throws DataAccessException Если произошла ошибка при получении пользователя.
     */
    Optional<UserRecord> getUserById(String id) throws DataAccessException;

    /**
     * Обновляет информацию о пользователе в базе данных.
     *
     * @param userRecord Объект пользователя с обновленными данными.
     * @throws DataAccessException Если произошла ошибка при обновлении пользователя.
     */
    void updateUser(UserRecord userRecord) throws DataAccessException;

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