Package edu.ucsb.cs156.example.controllers

Class HelpRequestController

java.lang.Object

edu.ucsb.cs156.example.controllers.ApiController

edu.ucsb.cs156.example.controllers.HelpRequestController

@RequestMapping("/api/HelpRequest")
@RestController
public class HelpRequestController
extends ApiController

This is a REST controller for HelpRequest

Constructor Summary

Constructors

Constructor	Description
HelpRequestController()

Method Summary

Modifier and Type	Method	Description
Iterable<HelpRequest>	allHelpRequests()	List all Help Requests
Object	deleteHelpRequest(Long id)	Delete a Help Request
HelpRequest	getById(Long id)	Get a Help Request by id
HelpRequest	postHelpRequest(String requesterEmail, String teamId, String tableOrBreakoutRoom, String explanation, boolean solved, LocalDateTime requestTime)	Create a new Help Request
HelpRequest	updateHelpRequest(Long id, @Valid HelpRequest incoming)	Update a single Help Request

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

HelpRequestController

public HelpRequestController()

Method Details

allHelpRequests

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

List all Help Requests

Returns:

an iterable of HelpRequest

getById

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

Get a Help Request by id

Parameters:

id - the id of the Help Request

Returns:

a HelpRequest

postHelpRequest

@PreAuthorize("hasRole(\'ROLE_ADMIN\')")
@PostMapping("/post")
public HelpRequest postHelpRequest(@RequestParam
 String requesterEmail,
 @RequestParam
 String teamId,
 @RequestParam
 String tableOrBreakoutRoom,
 @RequestParam
 String explanation,
 @RequestParam
 boolean solved,
 @RequestParam("requestTime") @DateTimeFormat(iso=DATE_TIME)
 LocalDateTime requestTime)
                            throws com.fasterxml.jackson.core.JsonProcessingException

Create a new Help Request

Parameters:

requesterEmail - email of requesting student

teamId - team id of requesting student

tableOrBreakoutRoom - table/breakout room number of requesting student

explanation - reason/explanation for request

solved - true iff request has been solved

requestTime - the date and time of request submission in local time

Returns:

the saved HelpRequest

Throws:

com.fasterxml.jackson.core.JsonProcessingException

deleteHelpRequest

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

Delete a Help Request

Parameters:

id - the id of the Help Request to delete

Returns:

a message indicating the Help Request was deleted

updateHelpRequest

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

Update a single Help Request

Parameters:

id - id of the Help Request to update

incoming - the new Help Request

Returns:

the updated Help Request object