org.optaweb.employeerostering.shared.roster

Interface RosterRestService

@Path(value="/tenant/{tenantId}/roster")
 @Produces(value="application/json")
 @Consumes(value="application/json")
 @GenRestBuilder
public interface RosterRestService

Method Summary

Modifier and Type	Method and Description
AvailabilityRosterView	getAvailabilityRosterView(Integer tenantId, Integer pageNumber, Integer numberOfItemsPerPage, String startDateString, String endDateString)
AvailabilityRosterView	getAvailabilityRosterViewFor(Integer tenantId, String startDateString, String endDateString, List<Employee> employees)
AvailabilityRosterView	getCurrentAvailabilityRosterView(Integer tenantId, Integer pageNumber, Integer numberOfItemsPerPage)
ShiftRosterView	getCurrentShiftRosterView(Integer tenantId, Integer pageNumber, Integer numberOfItemsPerPage)
RosterState	getRosterState(Integer tenantId)
ShiftRosterView	getShiftRosterView(Integer tenantId, Integer pageNumber, Integer numberOfItemsPerPage, String startDateString, String endDateString)
ShiftRosterView	getShiftRosterViewFor(Integer tenantId, String startDateString, String endDateString, List<Spot> spots)
PublishResult	publishAndProvision(Integer tenantId)
void	solveRoster(Integer tenantId)
void	terminateRosterEarly(Integer tenantId)

Method Detail

getRosterState

@GET
 @Path(value="/state")
RosterState getRosterState(@PathParam(value="tenantId")
                                                       Integer tenantId)

getCurrentShiftRosterView

@GET
 @Path(value="/shiftRosterView/current")
ShiftRosterView getCurrentShiftRosterView(@PathParam(value="tenantId")
                                                                                        Integer tenantId,
                                                                                        @QueryParam(value="p")
                                                                                        Integer pageNumber,
                                                                                        @QueryParam(value="n")
                                                                                        Integer numberOfItemsPerPage)

getShiftRosterView

@GET
 @Path(value="/shiftRosterView")
ShiftRosterView getShiftRosterView(@PathParam(value="tenantId")
                                                                         Integer tenantId,
                                                                         @QueryParam(value="p")
                                                                         Integer pageNumber,
                                                                         @QueryParam(value="n")
                                                                         Integer numberOfItemsPerPage,
                                                                         @QueryParam(value="startDate")
                                                                         String startDateString,
                                                                         @QueryParam(value="endDate")
                                                                         String endDateString)

getShiftRosterViewFor

@POST
 @Path(value="/shiftRosterView/for")
ShiftRosterView getShiftRosterViewFor(@PathParam(value="tenantId")
                                                                                 Integer tenantId,
                                                                                 @QueryParam(value="startDate")
                                                                                 String startDateString,
                                                                                 @QueryParam(value="endDate")
                                                                                 String endDateString,
                                                                                 List<Spot> spots)

getCurrentAvailabilityRosterView

@GET
 @Path(value="/availabilityRosterView/current")
AvailabilityRosterView getCurrentAvailabilityRosterView(@PathParam(value="tenantId")
                                                                                                             Integer tenantId,
                                                                                                             @QueryParam(value="p")
                                                                                                             Integer pageNumber,
                                                                                                             @QueryParam(value="n")
                                                                                                             Integer numberOfItemsPerPage)

getAvailabilityRosterView

@GET
 @Path(value="/availabilityRosterView")
AvailabilityRosterView getAvailabilityRosterView(@PathParam(value="tenantId")
                                                                                              Integer tenantId,
                                                                                              @QueryParam(value="p")
                                                                                              Integer pageNumber,
                                                                                              @QueryParam(value="n")
                                                                                              Integer numberOfItemsPerPage,
                                                                                              @QueryParam(value="startDate")
                                                                                              String startDateString,
                                                                                              @QueryParam(value="endDate")
                                                                                              String endDateString)

getAvailabilityRosterViewFor

@POST
 @Path(value="/availabilityRosterView/for")
AvailabilityRosterView getAvailabilityRosterViewFor(@PathParam(value="tenantId")
                                                                                                      Integer tenantId,
                                                                                                      @QueryParam(value="startDate")
                                                                                                      String startDateString,
                                                                                                      @QueryParam(value="endDate")
                                                                                                      String endDateString,
                                                                                                      List<Employee> employees)

solveRoster

@POST
 @Path(value="/solve")
void solveRoster(@PathParam(value="tenantId")
                                              Integer tenantId)

terminateRosterEarly

@POST
 @Path(value="/terminate")
void terminateRosterEarly(@PathParam(value="tenantId")
                                                           Integer tenantId)

publishAndProvision

@POST
 @Path(value="/publishAndProvision")
PublishResult publishAndProvision(@PathParam(value="tenantId")
                                                                             Integer tenantId)