Package io.extact.rms.client.api

Interface RentalReservationClientApi

public interface RentalReservationClientApi
レンタル予約アプリケーションのClient向けインターフェース

  • Method Details

    • authenticate

      UserAccountClientDto authenticate(String loginId, String password) throws BusinessFlowClientException
      ユーザをパスワードで認証する。

      Parameters:
      loginId - 認証するユーザのログインID
      password - 認証パスワード
      Returns:
      認証ユーザ。認証できなかった場合はnull
      Throws:
      BusinessFlowClientException - ユーザIDまたはパスワードに一致するユーザがいない

    • findReservationByRentalItemAndStartDate

      List<ReservationClientDto> findReservationByRentalItemAndStartDate(Integer rentalItemId, LocalDate startDate) throws BusinessFlowClientException
      指定されたレンタル品と利用開始日に対する予約を取得する。

      Parameters:
      rentalItemId - 予約のレンタル品ID
      startDate - 予約の利用開始日
      Returns:
      予約リスト（該当なしは例外を送出）
      Throws:
      BusinessFlowClientException - 該当なし

    • findReservationByReserverId

      List<ReservationClientDto> findReservationByReserverId(int reserverId)
      指定されたユーザが予約者の予約を取得する。
      Parameters:
      reserverId - 予約者のユーザID
      Returns:
      該当のリスト。該当なしは空リスト

    • getOwnReservations

      List<ReservationClientDto> getOwnReservations()
      ログインユーザが予約者の予約一覧を取得する。
      Returns:
      該当のリスト。該当なしは空リスト

    • getAllRentalItems

      List<RentalItemClientDto> getAllRentalItems()
      レンタル品の全件取得。

      Returns:
      レンタル品の全件。該当なしは空リスト

    • getAllUserAccounts

      List<UserAccountClientDto> getAllUserAccounts()
      ユーザの全件取得。

      Returns:
      ユーザの全件。該当なしは空リスト

    • addReservation

      ReservationClientDto addReservation(ReservationClientDto addReservationDto) throws BusinessFlowClientException
      レンタル品を予約する。

      Parameters:
      addReservationDto - 登録する予約
      Returns:
      登録された予約（idが設定されている）
      Throws:
      BusinessFlowClientException - 該当するレンタル品が存在しない場合、または期間が重複する予約が既に登録されている場合

    • addRentalItem

      RentalItemClientDto addRentalItem(RentalItemClientDto addRentalItemDto) throws BusinessFlowClientException
      レンタル品を登録する。

      Parameters:
      addRentalItemDto - 登録レンタル品
      Returns:
      登録されたレンタル品（idが設定されている）
      Throws:
      BusinessFlowClientException - 同一シリアル番号のレンタル品が既に登録されている場合

    • addUserAccount

      UserAccountClientDto addUserAccount(UserAccountClientDto addUserAccountDto) throws BusinessFlowClientException
      ユーザアカウントを登録する。

      Parameters:
      addUserAccountDto - 登録ユーザ
      Returns:
      登録されたユーザアカウント（idが設定されている）
      Throws:
      BusinessFlowClientException - 同一ログインIDのユーザが既に登録されている場合

    • cancelReservation

      void cancelReservation(int reservationId) throws BusinessFlowClientException
      予約をキャンセルする。

      Parameters:
      reservationId - 予約ID
      Throws:
      BusinessFlowClientException - 該当の予約が存在しない場合

    • updateUserAccount

      UserAccountClientDto updateUserAccount(UserAccountClientDto updateUserAccountDto)
      ユーザアカウントを更新する。

      Parameters:
      updateUserAccountDto - 更新ユーザ
      Returns:
      更新後のユーザアカウント