Package edu.ucsb.cs.scaffold.controller

Class RosterStudentsController

java.lang.Object

edu.ucsb.cs.scaffold.controller.ApiController

edu.ucsb.cs.scaffold.controller.RosterStudentsController

@RequestMapping("/api/rosterstudents")
@RestController
public class RosterStudentsController
extends ApiController

Constructor Summary

Constructors

Constructor	Description
RosterStudentsController()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<String>	deleteRosterStudent(Long id)
Iterable<RosterStudent>	getAssociatedRosterStudents()
org.springframework.http.ResponseEntity<UpsertResponse>	postRosterStudent(String studentId, String firstName, String lastName, String email, Long courseId, String section)	This method creates a new RosterStudent.
RosterStudent	restoreRosterStudent(Long id)
Iterable<RosterStudentDTO>	rosterStudentForCourse(Long courseId)	This method returns a list of roster students for a given course.
RosterStudent	updateRosterStudent(Long id, String firstName, String lastName, String studentId, String section)
static UpsertResponse	upsertStudent(RosterStudent student, Course course, RosterStatus rosterStatus)

Methods inherited from class edu.ucsb.cs.scaffold.controller.ApiController

genericMessage, getCurrentUser, handleEntityNotFoundException, handleForbiddenException, handleIllegalArgument, handleUnsupportedOperation

Methods inherited from class java.lang.Object

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

Constructor Details

RosterStudentsController

public RosterStudentsController()

Method Details

postRosterStudent

@PreAuthorize("@CourseSecurity.hasManagePermissions(#root, #courseId)")
@PostMapping("/post")
public org.springframework.http.ResponseEntity<UpsertResponse> postRosterStudent(@RequestParam
 String studentId,
 @RequestParam
 String firstName,
 @RequestParam
 String lastName,
 @RequestParam
 String email,
 @RequestParam
 Long courseId,
 @RequestParam(required=false)
 String section)
                                                                          throws EntityNotFoundException

This method creates a new RosterStudent. It is important to keep the code in this method consistent with the code for adding multiple roster students from a CSV

Returns:

the created RosterStudent

Throws:

EntityNotFoundException

rosterStudentForCourse

@PreAuthorize("@CourseSecurity.hasManagePermissions(#root, #courseId)")
@GetMapping("/course/{courseId}")
public Iterable<RosterStudentDTO> rosterStudentForCourse(@PathVariable
 Long courseId)
                                                  throws EntityNotFoundException

This method returns a list of roster students for a given course.

Returns:

a list of all courses.

Throws:

EntityNotFoundException

upsertStudent

public static UpsertResponse upsertStudent(RosterStudent student,
 Course course,
 RosterStatus rosterStatus)

getAssociatedRosterStudents

@PreAuthorize("hasRole(\'ROLE_USER\')")
@GetMapping("/associatedRosterStudents")
public Iterable<RosterStudent> getAssociatedRosterStudents()

updateRosterStudent

@PreAuthorize("@CourseSecurity.hasRosterStudentManagementPermissions(#root, #id)")
@PutMapping("/update")
public RosterStudent updateRosterStudent(@RequestParam
 Long id,
 @RequestParam(required=false)
 String firstName,
 @RequestParam(required=false)
 String lastName,
 @RequestParam(required=false)
 String studentId,
 @RequestParam(required=false)
 String section)
                                  throws EntityNotFoundException

Throws:

EntityNotFoundException

restoreRosterStudent

@PreAuthorize("@CourseSecurity.hasRosterStudentManagementPermissions(#root, #id)")
@PutMapping("/restore")
public RosterStudent restoreRosterStudent(@RequestParam
 Long id)
                                   throws EntityNotFoundException

Throws:

EntityNotFoundException

deleteRosterStudent

@PreAuthorize("@CourseSecurity.hasRosterStudentManagementPermissions(#root, #id)")
@DeleteMapping("/delete")
@Transactional
public org.springframework.http.ResponseEntity<String> deleteRosterStudent(@RequestParam
 Long id)
                                                                    throws EntityNotFoundException

Throws:

EntityNotFoundException