org.optaweb.employeerostering.shared.rotation

Interface RotationRestService

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

Method Summary

Modifier and Type	Method and Description
ShiftTemplateView	addShiftTemplate(Integer tenantId, ShiftTemplateView shiftTemplate)
ShiftTemplateView	getShiftTemplate(Integer tenantId, Long id)
List<ShiftTemplateView>	getShiftTemplateList(Integer tenantId)
Boolean	removeShiftTemplate(Integer tenantId, Long id)
ShiftTemplateView	updateShiftTemplate(Integer tenantId, ShiftTemplateView shiftTemplate)

Method Detail

getShiftTemplateList

@GET
 @Path(value="/")
List<ShiftTemplateView> getShiftTemplateList(@PathParam(value="tenantId")
                                                                    Integer tenantId)

getShiftTemplate

@GET
 @Path(value="/{id}")
ShiftTemplateView getShiftTemplate(@PathParam(value="tenantId")
                                                              Integer tenantId,
                                                              @PathParam(value="id")
                                                              Long id)

addShiftTemplate

@POST
 @Path(value="/add")
ShiftTemplateView addShiftTemplate(@PathParam(value="tenantId")
                                                              Integer tenantId,
                                                              ShiftTemplateView shiftTemplate)

Parameters:

shiftTemplate - never null, without an id/version

Returns:

never null, the added ShiftTemplate with id/version

updateShiftTemplate

@PUT
 @Path(value="/update")
ShiftTemplateView updateShiftTemplate(@PathParam(value="tenantId")
                                                                   Integer tenantId,
                                                                   ShiftTemplateView shiftTemplate)

Parameters:

shiftTemplate - never null

removeShiftTemplate

@DELETE
 @Path(value="/{id}")
Boolean removeShiftTemplate(@PathParam(value="tenantId")
                                                          Integer tenantId,
                                                          @PathParam(value="id")
                                                          Long id)

Parameters:

id - never null

Returns:

return true if the ShiftTemplate was removed, false otherwise