Package edu.ucsb.cs156.example.controllers

Class RecommendationRequestController

java.lang.Object

edu.ucsb.cs156.example.controllers.ApiController

edu.ucsb.cs156.example.controllers.RecommendationRequestController

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

This is a REST controller for RecommendationRequests

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 RecommendationRequest
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 date

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

RecommendationRequestController

public RecommendationRequestController()

Method Details

allRecommendationRequests

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

List all Recommendation Requests

Returns:

an iterable of Recommendation Requests

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 - email of requester

professorEmail - email of professor

explanation - explanation of request

dateRequested - date requested

dateNeeded - date needed

done - whether the request has been done or not

Returns:

the saved recommendation request

Throws:

com.fasterxml.jackson.core.JsonProcessingException

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 RecommendationRequest

updateRecommendationRequest

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

Update a single date

Parameters:

id - id of the recommendation request

incoming - the new recommendation request

Returns:

the updated RecommendationRequest object

deleteRecommendationRequest

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

Delete a RecommendationRequest

Parameters:

id - the id of the rceommendation request to delete

Returns:

a message indicating the recommendation request was deleted