Package org.optaweb.employeerostering.service.roster

Class RosterController

  • @RestController
@RequestMapping("/rest/tenant/{tenantId}/roster")
@CrossOrigin
@Validated
public class RosterController
extends Object

    • Method Detail

      • getRosterState

        @GetMapping("/{id}")
public org.springframework.http.ResponseEntity<RosterState> getRosterState​(@PathVariable @Min(0L)
                                                                           @Min(0L) Integer tenantId)

      • getCurrentShiftRosterView

        @GetMapping("/shiftRosterView/current")
public org.springframework.http.ResponseEntity<ShiftRosterView> getCurrentShiftRosterView​(@PathVariable @Min(0L)
                                                                                          @Min(0L) Integer tenantId,
                                                                                          @RequestParam(name="p",required=false)
                                                                                          Integer pageNumber,
                                                                                          @RequestParam(name="n",required=false)
                                                                                          Integer numberOfItemsPerPage)

      • getShiftRosterView

        @GetMapping("/shiftRosterView")
public org.springframework.http.ResponseEntity<ShiftRosterView> getShiftRosterView​(@PathVariable @Min(0L)
                                                                                   @Min(0L) Integer tenantId,
                                                                                   @RequestParam(name="p",required=false)
                                                                                   Integer pageNumber,
                                                                                   @RequestParam(name="n",required=false)
                                                                                   Integer numberOfItemsPerPage,
                                                                                   @RequestParam(name="startDate")
                                                                                   String startDateString,
                                                                                   @RequestParam(name="endDate")
                                                                                   String endDateString)

      • getShiftRosterViewFor

        @PostMapping("/shiftRosterView/for")
public org.springframework.http.ResponseEntity<ShiftRosterView> getShiftRosterViewFor​(@PathVariable @Min(0L)
                                                                                      @Min(0L) Integer tenantId,
                                                                                      @RequestParam(name="startDate")
                                                                                      String startDateString,
                                                                                      @RequestParam(name="endDate")
                                                                                      String endDateString,
                                                                                      @RequestBody @Valid
                                                                                      @Valid List<Spot> spots)

      • getShiftRosterViewAsExcel

        @GetMapping(value="/shiftRosterView/excel",
            produces="application/vnd.openxmlformats-officedocument.spreadsheetml.sheet")
public org.springframework.http.ResponseEntity<byte[]> getShiftRosterViewAsExcel​(@PathVariable @Min(0L)
                                                                                 @Min(0L) Integer tenantId,
                                                                                 @RequestParam(name="startDate")
                                                                                 String startDateString,
                                                                                 @RequestParam(name="endDate")
                                                                                 String endDateString,
                                                                                 @RequestParam(name="spotList")
                                                                                 String spotListString)

      • getCurrentAvailabilityRosterView

        @GetMapping("/availabilityRosterView/current")
public org.springframework.http.ResponseEntity<AvailabilityRosterView> getCurrentAvailabilityRosterView​(@PathVariable @Min(0L)
                                                                                                        @Min(0L) Integer tenantId,
                                                                                                        @RequestParam(name="p",required=false)
                                                                                                        Integer pageNumber,
                                                                                                        @RequestParam(name="n",required=false)
                                                                                                        Integer numberOfItemsPerPage)

      • getAvailabilityRosterView

        @GetMapping("/availabilityRosterView")
public org.springframework.http.ResponseEntity<AvailabilityRosterView> getAvailabilityRosterView​(@PathVariable @Min(0L)
                                                                                                 @Min(0L) Integer tenantId,
                                                                                                 @RequestParam(name="p",required=false)
                                                                                                 Integer pageNumber,
                                                                                                 @RequestParam(name="n",required=false)
                                                                                                 Integer numberOfItemsPerPage,
                                                                                                 @RequestParam(name="startDate")
                                                                                                 String startDateString,
                                                                                                 @RequestParam(name="endDate")
                                                                                                 String endDateString)

      • getAvailabilityRosterViewFor

        @PostMapping("/availabilityRosterView/for")
public org.springframework.http.ResponseEntity<AvailabilityRosterView> getAvailabilityRosterViewFor​(@PathVariable @Min(0L)
                                                                                                    @Min(0L) Integer tenantId,
                                                                                                    @RequestParam(name="startDate")
                                                                                                    String startDateString,
                                                                                                    @RequestParam(name="endDate")
                                                                                                    String endDateString,
                                                                                                    @RequestBody @Valid
                                                                                                    @Valid List<Employee> employees)

      • solveRoster

        @PostMapping("/solve")
public void solveRoster​(@PathVariable @Min(0L)
                        @Min(0L) Integer tenantId)

      • replanRoster

        @PostMapping("/replan")
public void replanRoster​(@PathVariable @Min(0L)
                         @Min(0L) Integer tenantId)

      • terminateRosterEarly

        @PostMapping("/terminate")
public void terminateRosterEarly​(@PathVariable @Min(0L)
                                 @Min(0L) Integer tenantId)

      • getSolverStatus

        @GetMapping("/status")
public org.springframework.http.ResponseEntity<SolverStatus> getSolverStatus​(@PathVariable @Min(0L)
                                                                             @Min(0L) Integer tenantId)

      • provision

        @PostMapping("/provision")
public void provision​(@PathVariable @Min(0L)
                      @Min(0L) Integer tenantId,
                      @RequestParam
                      Integer startRotationOffset,
                      @RequestParam
                      String fromDate,
                      @RequestParam
                      String toDate,
                      @RequestBody
                      List<Long> timeBucketIdList)

      • publishAndProvision

        @PostMapping("/publishAndProvision")
public org.springframework.http.ResponseEntity<PublishResult> publishAndProvision​(@PathVariable @Min(0L)
                                                                                  @Min(0L) Integer tenantId)

      • commitChanges

        @PostMapping("/commitChanges")
public void commitChanges​(@PathVariable @Min(0L)
                          @Min(0L) Integer tenantId)