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/recommendationrequests")
@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()
Object	deleteRecommendationRequest(Long id)	Delete a RecommendationRequest
RecommendationRequest	getById(Long id)	Get a single recommendationRequest by id
RecommendationRequest	postRecommendationRequest(String requesterEmail, String professorEmail, String explanation, LocalDateTime dateRequested, LocalDateTime dateNeeded, boolean done)	Create a new recommendationRequest
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()

getById

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

Get a single recommendationRequest by id

Parameters:

id - the id of the recommendationRequest

Returns:

a RecommendationRequest

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 recommendationRequest

Parameters:

requesterEmail - email of the requester

professorEmail - email of the professor

explanation - explanation

dateRequested - date requested

dateNeeded - date needed

done - completed or no

Returns:

the saved recommendationRequest

Throws:

com.fasterxml.jackson.core.JsonProcessingException

deleteRecommendationRequest

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

Delete a RecommendationRequest

Parameters:

id - the id of the request to delete

Returns:

a message indicating the request was deleted

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 request to update

incoming - the request date

Returns:

the updated request object