org.optaweb.employeerostering.service.roster

Class RosterController

java.lang.Object

org.optaweb.employeerostering.service.roster.RosterController

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

Constructor Summary

Constructors

Constructor and Description
RosterController(RosterService rosterService)

Method Summary

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<AvailabilityRosterView>	getAvailabilityRosterView(@Min(value=0L) Integer tenantId, Integer pageNumber, Integer numberOfItemsPerPage, String startDateString, String endDateString)
org.springframework.http.ResponseEntity<AvailabilityRosterView>	getAvailabilityRosterViewFor(@Min(value=0L) Integer tenantId, String startDateString, String endDateString, @Valid List<Employee> employees)
org.springframework.http.ResponseEntity<AvailabilityRosterView>	getCurrentAvailabilityRosterView(@Min(value=0L) Integer tenantId, Integer pageNumber, Integer numberOfItemsPerPage)
org.springframework.http.ResponseEntity<ShiftRosterView>	getCurrentShiftRosterView(@Min(value=0L) Integer tenantId, Integer pageNumber, Integer numberOfItemsPerPage)
org.springframework.http.ResponseEntity<RosterState>	getRosterState(@Min(value=0L) Integer tenantId)
org.springframework.http.ResponseEntity<ShiftRosterView>	getShiftRosterView(@Min(value=0L) Integer tenantId, Integer pageNumber, Integer numberOfItemsPerPage, String startDateString, String endDateString)
org.springframework.http.ResponseEntity<ShiftRosterView>	getShiftRosterViewFor(@Min(value=0L) Integer tenantId, String startDateString, String endDateString, @Valid List<Spot> spots)
org.springframework.http.ResponseEntity<PublishResult>	publishAndProvision(@Min(value=0L) Integer tenantId)
void	solveRoster(@Min(value=0L) Integer tenantId)
void	terminateRosterEarly(@Min(value=0L) Integer tenantId)

Methods inherited from class java.lang.Object

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

Constructor Detail

RosterController

public RosterController(RosterService rosterService)

Method Detail

getRosterState

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

getCurrentShiftRosterView

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

getShiftRosterView

@GetMapping(value="/shiftRosterView")
public org.springframework.http.ResponseEntity<ShiftRosterView> getShiftRosterView(@PathVariable @Min(value=0L)
                                                                                                                         @Min(value=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(value="/shiftRosterView/for")
public org.springframework.http.ResponseEntity<ShiftRosterView> getShiftRosterViewFor(@PathVariable @Min(value=0L)
                                                                                                                                 @Min(value=0L) Integer tenantId,
                                                                                                                                 @RequestParam(name="startDate")
                                                                                                                                 String startDateString,
                                                                                                                                 @RequestParam(name="endDate")
                                                                                                                                 String endDateString,
                                                                                                                                 @RequestBody @Valid
                                                                                                                                 @Valid List<Spot> spots)

getCurrentAvailabilityRosterView

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

getAvailabilityRosterView

@GetMapping(value="/availabilityRosterView")
public org.springframework.http.ResponseEntity<AvailabilityRosterView> getAvailabilityRosterView(@PathVariable @Min(value=0L)
                                                                                                                                              @Min(value=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(value="/availabilityRosterView/for")
public org.springframework.http.ResponseEntity<AvailabilityRosterView> getAvailabilityRosterViewFor(@PathVariable @Min(value=0L)
                                                                                                                                                      @Min(value=0L) Integer tenantId,
                                                                                                                                                      @RequestParam(name="startDate")
                                                                                                                                                      String startDateString,
                                                                                                                                                      @RequestParam(name="endDate")
                                                                                                                                                      String endDateString,
                                                                                                                                                      @RequestBody @Valid
                                                                                                                                                      @Valid List<Employee> employees)

solveRoster

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

terminateRosterEarly

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

publishAndProvision

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