Package com.amos2020.javabackend.rest_service

Class AuditRestService

java.lang.Object
com.amos2020.javabackend.rest_service.AuditRestService
@RestController
@Validated
@CrossOrigin
public class AuditRestService
extends java.lang.Object
Provides endpoints for the audit resource under /audits

  • Field Summary

    Fields 
    Modifier and Type Field Description
    (package private) AuditController auditController  

  • Constructor Summary

    Constructors 
    Constructor Description
    AuditRestService​(AuditController auditController)  

  • Method Summary

    Modifier and Type Method Description
    org.springframework.http.ResponseEntity<BasicAuditResponse> addContactPersonToAudit​(@javax.validation.constraints.Min(1L) int auditId, @javax.validation.constraints.Min(1L) int contactPersonId)
    PUT for adding a contactPerson to an audit
    org.springframework.http.ResponseEntity<BasicAuditResponse> createAudit​(@Valid CreateAuditRequest request)
    POST endpoint for creating an audit associated with a scope and audit_contact_person
    org.springframework.http.ResponseEntity<BasicAuditResponse> deleteAudit​(@javax.validation.constraints.Min(1L) int auditId, @Valid DeleteAuditRequest request)
    DELETE endpoint for deleting an audit
    org.springframework.http.ResponseEntity<java.util.List<BasicAuditResponse>> getAuditAll()
    GET endpoint for fetching a list of all audits
    org.springframework.http.ResponseEntity<BasicAuditResponse> getAuditById​(@javax.validation.constraints.Min(1L) int auditId)
    GET endpoint for fetching a specific audit by id
    org.springframework.http.ResponseEntity<BasicAuditResponse> removeContactPersonFromAudit​(@javax.validation.constraints.Min(1L) int auditId, @javax.validation.constraints.Min(1L) int contactPersonId)
    DELETE for removing a contactPerson from an audit
    org.springframework.http.ResponseEntity<BasicAuditResponse> updateAudit​(@javax.validation.constraints.Min(1L) int auditId, @Valid UpdateAuditRequest request)
    PUT endpoint for changing the data (name, startDate, endDate) of an audit
    org.springframework.http.ResponseEntity<BasicAuditResponse> updateAuditScope​(@javax.validation.constraints.Min(1L) int auditId, @Valid UpdateAuditScopeRequest request)
    PUT endpoint for changing a faccrit in the scope of an audit or the corresponding contact people

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

  • Method Details

    • createAudit

      @PostMapping("/audits") public org.springframework.http.ResponseEntity<BasicAuditResponse> createAudit​(@RequestBody @Valid @Valid CreateAuditRequest request)
      POST endpoint for creating an audit associated with a scope and audit_contact_person
      Parameters:
      request - CreateAuditRequest
      Returns:
      BasicAuditResponse

    • updateAudit

      @PutMapping("/audits/{id}") public org.springframework.http.ResponseEntity<BasicAuditResponse> updateAudit​(@PathVariable("id") @Min(1L) @javax.validation.constraints.Min(1L) int auditId, @RequestBody @Valid @Valid UpdateAuditRequest request)
      PUT endpoint for changing the data (name, startDate, endDate) of an audit
      Parameters:
      auditId - int
      request - UpdateAuditRequest
      Returns:
      BasicAuditResponse

    • addContactPersonToAudit

      @PutMapping("/audits/{id}/contactpersons/{contactPersonId}") public org.springframework.http.ResponseEntity<BasicAuditResponse> addContactPersonToAudit​(@PathVariable("id") @Min(1L) @javax.validation.constraints.Min(1L) int auditId, @PathVariable("contactPersonId") @Min(1L) @javax.validation.constraints.Min(1L) int contactPersonId)
      PUT for adding a contactPerson to an audit
      Parameters:
      auditId - int
      contactPersonId - int
      Returns:
      BasicAuditResponse

    • removeContactPersonFromAudit

      @DeleteMapping("/audits/{id}/contactpersons/{contactPersonId}") public org.springframework.http.ResponseEntity<BasicAuditResponse> removeContactPersonFromAudit​(@PathVariable("id") @Min(1L) @javax.validation.constraints.Min(1L) int auditId, @PathVariable("contactPersonId") @Min(1L) @javax.validation.constraints.Min(1L) int contactPersonId)
      DELETE for removing a contactPerson from an audit
      Parameters:
      auditId - int
      contactPersonId - int
      Returns:
      BasicAuditResponse

    • updateAuditScope

      @PutMapping("/audits/{id}/scope") public org.springframework.http.ResponseEntity<BasicAuditResponse> updateAuditScope​(@PathVariable("id") @Min(1L) @javax.validation.constraints.Min(1L) int auditId, @RequestBody @Valid @Valid UpdateAuditScopeRequest request)
      PUT endpoint for changing a faccrit in the scope of an audit or the corresponding contact people
      Parameters:
      auditId - int
      request - UpdateAuditScopeRequest
      Returns:
      BasicAuditResponse

    • deleteAudit

      @DeleteMapping("/audits/{id}") public org.springframework.http.ResponseEntity<BasicAuditResponse> deleteAudit​(@PathVariable("id") @Min(1L) @javax.validation.constraints.Min(1L) int auditId, @RequestBody @Valid @Valid DeleteAuditRequest request)
      DELETE endpoint for deleting an audit
      Parameters:
      auditId - int
      request - DeleteAuditRequest
      Returns:
      BasicAuditResponse

    • getAuditById

      @GetMapping("/audits/{id}") public org.springframework.http.ResponseEntity<BasicAuditResponse> getAuditById​(@PathVariable("id") @Min(1L) @javax.validation.constraints.Min(1L) int auditId)
      GET endpoint for fetching a specific audit by id
      Parameters:
      auditId - int
      Returns:
      BasicAuditResponse

    • getAuditAll

      @GetMapping("/audits") public org.springframework.http.ResponseEntity<java.util.List<BasicAuditResponse>> getAuditAll()
      GET endpoint for fetching a list of all audits
      Returns:
      List