Package edu.ucsb.cs156.example.controllers

Class MenuItemReviewController

java.lang.Object

edu.ucsb.cs156.example.controllers.ApiController

edu.ucsb.cs156.example.controllers.MenuItemReviewController

@RequestMapping("/api/menuitemreviews")
@RestController
public class MenuItemReviewController
extends ApiController

This is a REST controller for MenuItemReviews

Constructor Summary

Constructors

Constructor	Description
MenuItemReviewController()

Method Summary

Modifier and Type	Method	Description
Iterable<MenuItemReview>	allMenuItemReviews()	List all menu item reviews
Object	deleteMenuItemReview(Long id)	Delete a menu item review
MenuItemReview	getById(Long id)	Get a single review by id
MenuItemReview	postMenuItemReview(long itemID, String reviewerEmail, int stars, LocalDateTime reviewDate, String comments)	Create a new menu item review.
MenuItemReview	updateReview(Long id, @Valid MenuItemReview incoming)	Update a single review

Methods inherited from class edu.ucsb.cs156.example.controllers.ApiController

genericMessage, getCurrentUser, handleGenericException

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MenuItemReviewController

public MenuItemReviewController()

Method Details

allMenuItemReviews

@PreAuthorize("hasRole(\'ROLE_USER\')")
@GetMapping("/all")
public Iterable<MenuItemReview> allMenuItemReviews()

List all menu item reviews

Returns:

an iterable of MenuItemReview

postMenuItemReview

@PreAuthorize("hasRole(\'ROLE_ADMIN\')")
@PostMapping("/post")
public MenuItemReview postMenuItemReview(@RequestParam
 long itemID,
 @RequestParam
 String reviewerEmail,
 @RequestParam
 int stars,
 @RequestParam("reviewDate") @DateTimeFormat(iso=DATE_TIME)
 LocalDateTime reviewDate,
 @RequestParam
 String comments)
                                  throws com.fasterxml.jackson.core.JsonProcessingException

Create a new menu item review.

Parameters:

itemID - the ID of the menu item being reviewed

reviewerEmail - the email of the reviewer

stars - the number of stars given in the review

reviewDate - the date and time of the review

comments - the comments included in the review

Returns:

the saved MenuItemReview

Throws:

com.fasterxml.jackson.core.JsonProcessingException - if there is an error processing JSON

getById

@PreAuthorize("hasRole(\'ROLE_USER\')")
@GetMapping("")
public MenuItemReview getById(@RequestParam
 Long id)

Get a single review by id

Parameters:

id - the id of the review

Returns:

a MenuItemReview

updateReview

@PreAuthorize("hasRole(\'ROLE_ADMIN\')")
@PutMapping("")
public MenuItemReview updateReview(@RequestParam
 Long id,
 @RequestBody @Valid
 @Valid MenuItemReview incoming)

Update a single review

Parameters:

id - id of the review to update

incoming - the new review

Returns:

the updated review object

deleteMenuItemReview

@PreAuthorize("hasRole(\'ROLE_ADMIN\')")
@DeleteMapping("")
public Object deleteMenuItemReview(@RequestParam
 Long id)

Delete a menu item review

Parameters:

id - the id of the review to delete

Returns:

a message indicating the review was deleted