Package edu.ucsb.cs156.rec.controllers

Class RecommendationRequestController

java.lang.Object

edu.ucsb.cs156.rec.controllers.ApiController

edu.ucsb.cs156.rec.controllers.RecommendationRequestController

@RequestMapping("/api/recommendationrequest")
@RestController
public class RecommendationRequestController
extends ApiController

This is a REST controller for RecommendationRequest

Constructor Summary

Constructors

Constructor	Description
RecommendationRequestController()

Method Summary

Modifier and Type	Method	Description
Iterable<RecommendationRequest>	allRecommendationRequests()	List all recommendation requests
Object	deleteRecommendationRequest(Long id)	Delete a recommendation request
RecommendationRequest	getById(Long id)	Get a single recommendation request by id
RecommendationRequest	postRecommendationRequest(String requesterEmail, String professorEmail, String explanation, LocalDateTime dateRequested, LocalDateTime dateNeeded, boolean done)	Create a new recommendation request
RecommendationRequest	updateRecommendationRequest(Long id, @Valid RecommendationRequest incoming)	Update a single recommendation request

Methods inherited from class edu.ucsb.cs156.rec.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

RecommendationRequestController

public RecommendationRequestController()

Method Details

allRecommendationRequests

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

List all recommendation requests

Returns:

an iterable of RecommendationRequest

getById

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

Get a single recommendation request by id

Parameters:

id - the id of the recommendation request

Returns:

a recommendation request

postRecommendationRequest

@PreAuthorize("hasRole(\'ROLE_ADMIN\')")
@PostMapping("/post")
public RecommendationRequest postRecommendationRequest(@RequestParam
 String requesterEmail,
 @RequestParam
 String professorEmail,
 @RequestParam
 String explanation,
 @RequestParam("dateRequested") @DateTimeFormat(iso=DATE_TIME)
 LocalDateTime dateRequested,
 @RequestParam("dateNeeded") @DateTimeFormat(iso=DATE_TIME)
 LocalDateTime dateNeeded,
 @RequestParam
 boolean done)
                                                throws com.fasterxml.jackson.core.JsonProcessingException

Create a new recommendation request

Parameters:

requesterEmail - the email of the requester

professorEmail - the email of the professor

explanation - the explanation of the request

dateRequested - the date the request was made

dateNeeded - the date the request is needed

done - whether the request is done

Returns:

the created RecommendationRequest

Throws:

com.fasterxml.jackson.core.JsonProcessingException

deleteRecommendationRequest

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

Delete a recommendation request

Parameters:

id - the id of the recommendation request to delete

Returns:

a message indicating the recommedation request was deleted

updateRecommendationRequest

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

Update a single recommendation request

Parameters:

id - id of the recommendation request to update

incoming - the new recommendation request

Returns:

the updated recommendation request object