Package com.amos2020.javabackend.rest_service

Class ScopeRestService

java.lang.Object
com.amos2020.javabackend.rest_service.ScopeRestService
@RestController
@Validated
@CrossOrigin
public class ScopeRestService
extends java.lang.Object
Provides endpoints for the scope resource under /audits/{id}/scope

  • Field Summary

    Fields 
    Modifier and Type Field Description
    private ScopeController scopeController  

  • Constructor Summary

    Constructors 
    Constructor Description
    ScopeRestService​(ScopeController scopeController)  

  • Method Summary

    Modifier and Type Method Description
    org.springframework.http.ResponseEntity<BasicScopeResponse> addScope​(@javax.validation.constraints.Min(1L) int auditId, @javax.validation.constraints.Min(1L) int facCritId, @Valid UpdateScopeRequest request)  
    org.springframework.http.ResponseEntity<java.util.List<BasicScopeResponse>> addScope​(@javax.validation.constraints.Min(1L) int auditId, @Valid AddScopeRequest request)  
    org.springframework.http.ResponseEntity<java.util.List<BasicScopeResponse>> getAllScopes​(@javax.validation.constraints.Min(1L) int auditId)
    GET Endpoint for fetching all existing Scopes
    org.springframework.http.ResponseEntity<BasicScopeResponse> getScopeByIds​(@javax.validation.constraints.Min(1L) int auditId, @javax.validation.constraints.Min(1L) int faccritId)
    GET Endpoint for fetching a specific Scope identified by its Audit id and Faccrit id

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

  • Method Details

    • addScope

      @PostMapping("/audits/{id}/scope") public org.springframework.http.ResponseEntity<java.util.List<BasicScopeResponse>> addScope​(@PathVariable("id") @Min(1L) @javax.validation.constraints.Min(1L) int auditId, @RequestBody @Valid @Valid AddScopeRequest request)
      Parameters:
      auditId - int
      request - AddScopeRequest
      Returns:
      List of created Scope objects

    • addScope

      @PutMapping("/audits/{id}/scope/{faccritid}") public org.springframework.http.ResponseEntity<BasicScopeResponse> addScope​(@PathVariable("id") @Min(1L) @javax.validation.constraints.Min(1L) int auditId, @PathVariable("faccritid") @Min(1L) @javax.validation.constraints.Min(1L) int facCritId, @RequestBody @Valid @Valid UpdateScopeRequest request)
      Parameters:
      auditId - int
      facCritId - int
      request - UpdateScopeRequest
      Returns:
      Updated Scope object

    • getScopeByIds

      @GetMapping("/audits/{id1}/scope/{id2}") public org.springframework.http.ResponseEntity<BasicScopeResponse> getScopeByIds​(@PathVariable("id1") @Min(1L) @javax.validation.constraints.Min(1L) int auditId, @PathVariable("id2") @Min(1L) @javax.validation.constraints.Min(1L) int faccritId)
      GET Endpoint for fetching a specific Scope identified by its Audit id and Faccrit id
      Parameters:
      auditId - int
      faccritId - int
      Returns:
      Scope object for the given audit id and faccrit id

    • getAllScopes

      @GetMapping("/audits/{id}/scope") public org.springframework.http.ResponseEntity<java.util.List<BasicScopeResponse>> getAllScopes​(@PathVariable("id") @Min(1L) @javax.validation.constraints.Min(1L) int auditId)
      GET Endpoint for fetching all existing Scopes
      Parameters:
      auditId - int
      Returns:
      List of all Scope objects belonging to an audit