Package edu.ucsb.cs.scaffold.controller

Class ConceptsController

java.lang.Object

edu.ucsb.cs.scaffold.controller.ApiController

edu.ucsb.cs.scaffold.controller.ConceptsController

@RestController
public class ConceptsController
extends ApiController

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ConceptsController.ConceptContentDTO
static final record	ConceptsController.CourseConceptDTO
static final record	ConceptsController.CycleEdgeDTO
static final record	ConceptsController.EdgeDTO
static final record	ConceptsController.LevelAssignmentDTO
static final record	ConceptsController.MajorConceptDTO
static final record	ConceptsController.PositionDTO
static final record	ConceptsController.RemovedEdgeDTO
static final record	ConceptsController.ScaffoldResetReportDTO
static final record	ConceptsController.ScaffoldResetResponseDTO
static final record	ConceptsController.ScaffoldSpacingDTO
static final record	ConceptsController.SubconceptDTO
static final record	ConceptsController.SubConceptTableRowDTO
static final record	ConceptsController.TopLevelConceptDTO

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_TOP_LEVEL_COLOR
static final int	MAX_RENDERED_CONCEPT_LABEL_LENGTH
static final int	MAX_RENDERED_SUBCONCEPT_LABEL_LENGTH

Constructor Summary

Constructors

Constructor	Description
ConceptsController()

Method Summary

Modifier and Type	Method	Description
Object	deleteConcept(Long conceptId)
Object	deleteConceptEdge(Long id)
Concept	designateSubconcept(Long conceptId, Long parentConceptId)
Map<Long,ConceptsController.ConceptContentDTO>	getContent(Long courseId)
List<ConceptsController.CourseConceptDTO>	getCourseConcepts(Long courseId)
List<ConceptsController.EdgeDTO>	getEdges(Long courseId)
List<ConceptsController.MajorConceptDTO>	getGraph(Long courseId)
Map<Long,ConceptsController.PositionDTO>	getPositions(Long courseId)
List<ConceptsController.SubConceptTableRowDTO>	getSubconcepts(Long courseId)
List<ConceptsController.TopLevelConceptDTO>	getTopLevelConcepts(Long courseId)
Concept	postConcept(CreateConceptDTO dto)
ConceptEdge	postConceptEdge(Long sourceConceptId, Long targetConceptId)
PracticeProblem	postPracticeProblem(Long conceptId, String url)
Concept	postSubconcept(CreateSubconceptDTO dto)
Concept	putConcept(Long conceptId, UpdateConceptDTO dto)
Concept	putSubconcept(Long conceptId, UpdateSubconceptDTO dto)
List<ConceptsController.SubconceptDTO>	reorderSubconcepts(Long parentConceptId, List<Long> orderedSubconceptIds)
ConceptsController.ScaffoldResetResponseDTO	resetCourseScaffold(Long courseId)
Concept	splitOffSubconcept(Long conceptId, Integer x, Integer y)
ConceptsController.ScaffoldSpacingDTO	updateScaffoldSpacing(Long courseId, int xSpacing, int ySpacing)

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

Field Details

MAX_RENDERED_CONCEPT_LABEL_LENGTH

public static final int MAX_RENDERED_CONCEPT_LABEL_LENGTH

See Also:

• Constant Field Values

MAX_RENDERED_SUBCONCEPT_LABEL_LENGTH

public static final int MAX_RENDERED_SUBCONCEPT_LABEL_LENGTH

See Also:

• Constant Field Values

DEFAULT_TOP_LEVEL_COLOR

public static final String DEFAULT_TOP_LEVEL_COLOR

See Also:

• Constant Field Values

Constructor Details

ConceptsController

public ConceptsController()

Method Details

getContent

@PreAuthorize("hasRole(\'ROLE_USER\')")
@GetMapping("/api/concepts/content")
public Map<Long,ConceptsController.ConceptContentDTO> getContent(@RequestParam
 Long courseId)

getCourseConcepts

@PreAuthorize("hasRole(\'ROLE_USER\')")
@GetMapping("/api/concepts/course")
public List<ConceptsController.CourseConceptDTO> getCourseConcepts(@RequestParam
 Long courseId)

getGraph

@PreAuthorize("hasRole(\'ROLE_USER\')")
@GetMapping("/api/concepts/graph")
public List<ConceptsController.MajorConceptDTO> getGraph(@RequestParam
 Long courseId)

getPositions

@PreAuthorize("hasRole(\'ROLE_USER\')")
@GetMapping("/api/concepts/positions")
public Map<Long,ConceptsController.PositionDTO> getPositions(@RequestParam
 Long courseId)

getTopLevelConcepts

@PreAuthorize("hasRole(\'ROLE_USER\')")
@GetMapping("/api/concepts/top-level")
public List<ConceptsController.TopLevelConceptDTO> getTopLevelConcepts(@RequestParam
 Long courseId)

getSubconcepts

@PreAuthorize("hasRole(\'ROLE_USER\')")
@GetMapping("/api/concepts/subconcepts")
public List<ConceptsController.SubConceptTableRowDTO> getSubconcepts(@RequestParam
 Long courseId)

getEdges

@PreAuthorize("hasRole(\'ROLE_USER\')")
@GetMapping("/api/concepts/edges")
public List<ConceptsController.EdgeDTO> getEdges(@RequestParam
 Long courseId)

postConcept

@PreAuthorize("@CourseSecurity.hasManagePermissions(#root, #dto.courseId)")
@PostMapping(value="/api/concept",
             consumes={"application/yaml","application/x-yaml","application/json"})
public Concept postConcept(@RequestBody
 CreateConceptDTO dto)
                    throws EntityNotFoundException

Throws:

EntityNotFoundException

postSubconcept

@PreAuthorize("@CourseSecurity.hasManagePermissions(#root, #dto.courseId)")
@PostMapping(value="/api/concept/subconcept",
             consumes={"application/yaml","application/x-yaml","application/json"})
public Concept postSubconcept(@RequestBody
 CreateSubconceptDTO dto)
                       throws EntityNotFoundException

Throws:

EntityNotFoundException

putConcept

@PreAuthorize("@CourseSecurity.hasConceptManagementPermissions(#root, #conceptId)")
@PutMapping("/api/concept/put")
public Concept putConcept(@RequestParam
 Long conceptId,
 @RequestBody
 UpdateConceptDTO dto)
                   throws EntityNotFoundException

Throws:

EntityNotFoundException

putSubconcept

@PreAuthorize("@CourseSecurity.hasConceptManagementPermissions(#root, #conceptId)")
@PutMapping("/api/concept/subconcept/put")
public Concept putSubconcept(@RequestParam
 Long conceptId,
 @RequestBody
 UpdateSubconceptDTO dto)
                      throws EntityNotFoundException

Throws:

EntityNotFoundException

postPracticeProblem

@PreAuthorize("@CourseSecurity.hasConceptManagementPermissions(#root, #conceptId)")
@PostMapping("/api/concepts/practiceproblems/post")
public PracticeProblem postPracticeProblem(@RequestParam
 Long conceptId,
 @RequestParam
 String url)
                                    throws EntityNotFoundException

Throws:

EntityNotFoundException

designateSubconcept

@PreAuthorize("@CourseSecurity.hasConceptManagementPermissions(#root, #conceptId)")
@PutMapping("/api/concepts/designate")
public Concept designateSubconcept(@RequestParam
 Long conceptId,
 @RequestParam
 Long parentConceptId)
                            throws EntityNotFoundException

Throws:

EntityNotFoundException

splitOffSubconcept

@PreAuthorize("@CourseSecurity.hasConceptManagementPermissions(#root, #conceptId)")
@PutMapping("/api/concepts/splitoff")
public Concept splitOffSubconcept(@RequestParam
 Long conceptId,
 @RequestParam
 Integer x,
 @RequestParam
 Integer y)
                           throws EntityNotFoundException

Throws:

EntityNotFoundException

reorderSubconcepts

@PreAuthorize("@CourseSecurity.hasConceptManagementPermissions(#root, #parentConceptId)")
@PutMapping("/api/concepts/subconcepts/reorder")
public List<ConceptsController.SubconceptDTO> reorderSubconcepts(@RequestParam
 Long parentConceptId,
 @RequestBody
 List<Long> orderedSubconceptIds)
                                                          throws EntityNotFoundException

Throws:

EntityNotFoundException

postConceptEdge

@PreAuthorize("@CourseSecurity.hasConceptManagementPermissions(#root, #sourceConceptId)")
@PostMapping("/api/concepts/edges/post")
public ConceptEdge postConceptEdge(@RequestParam
 Long sourceConceptId,
 @RequestParam
 Long targetConceptId)
                            throws EntityNotFoundException

Throws:

EntityNotFoundException

deleteConceptEdge

@PreAuthorize("@CourseSecurity.hasConceptEdgeManagementPermissions(#root, #id)")
@DeleteMapping("/api/concepts/edges/delete")
public Object deleteConceptEdge(@RequestParam
 Long id)
                         throws EntityNotFoundException

Throws:

EntityNotFoundException

deleteConcept

@PreAuthorize("@CourseSecurity.hasConceptManagementPermissions(#root, #conceptId)")
@DeleteMapping("/api/concept/delete")
public Object deleteConcept(@RequestParam
 Long conceptId)
                     throws EntityNotFoundException

Throws:

EntityNotFoundException

resetCourseScaffold

@PreAuthorize("@CourseSecurity.hasManagePermissions(#root, #courseId)")
@PostMapping("/api/course/scaffold/reset")
public ConceptsController.ScaffoldResetResponseDTO resetCourseScaffold(@RequestParam
 Long courseId)
                                                                throws EntityNotFoundException

Throws:

EntityNotFoundException

updateScaffoldSpacing

@PreAuthorize("@CourseSecurity.hasManagePermissions(#root, #courseId)")
@PutMapping("/api/course/scaffold/spacing")
public ConceptsController.ScaffoldSpacingDTO updateScaffoldSpacing(@RequestParam
 Long courseId,
 @RequestParam
 int xSpacing,
 @RequestParam
 int ySpacing)
                                                            throws EntityNotFoundException

Throws:

EntityNotFoundException