Package com.dzidzi.api

Interface CustomerReviewApi

public interface CustomerReviewApi
CustomerReviewApi contains all the api operations for handling CustomerReview of DzidziApp

  • Method Details

    • findReviewById

      CustomerReview findReviewById(UUID reviewId)
      Finds the customer review by id.
      Parameters:
      reviewId - the review id
      Returns:
      the customer review found
      Throws:
      com.dzidzi.exception.EntityNotFoundException - when review is not found

    • createReview

      CustomerReview createReview(AddCustomerReviewRequest request)
      Adds/creates a new review.
      Parameters:
      request - the AddCustomerReviewRequest to create/add a new review
      Returns:
      the newly created review

    • editReview

      CustomerReview editReview(ChangeCustomerReviewRequest changeCustomerReviewRequest)
      Changes a field/all fields of an existing review.
      Parameters:
      changeCustomerReviewRequest - the ChangeCustomerReviewRequest containing the changes
      Returns:
      the updated customer review

    • deleteReview

      void deleteReview(UUID reviewId)
      Deletes a review by id.
      Parameters:
      reviewId - the review id

    • findReviews

      DzidziPaginationDTO<CustomerReview> findReviews(FindReviewRequest findReviewRequest)
      Finds the paginated reviews based on the request.
      Parameters:
      findReviewRequest - the request containing the params to filter reviews on
      Returns:
      the DzidziPaginationDTO