org.optaweb.employeerostering.shared.shift

Interface ShiftRestService

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

Method Summary

Modifier and Type	Method and Description
ShiftView	addShift(Integer tenantId, ShiftView shift)
ShiftView	getShift(Integer tenantId, Long id)
List<ShiftView>	getShiftList(Integer tenantId)
Boolean	removeShift(Integer tenantId, Long id)
ShiftView	updateShift(Integer tenantId, ShiftView shift)

Method Detail

getShiftList

@GET
 @Path(value="/")
List<ShiftView> getShiftList(@PathParam(value="tenantId")
                                                    Integer tenantId)

getShift

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

addShift

@POST
 @Path(value="/add")
ShiftView addShift(@PathParam(value="tenantId")
                                              Integer tenantId,
                                              ShiftView shift)

Parameters:

shift - never null

Returns:

never null, the id

updateShift

@PUT
 @Path(value="/update")
ShiftView updateShift(@PathParam(value="tenantId")
                                                   Integer tenantId,
                                                   ShiftView shift)

Parameters:

shift - never null

removeShift

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

Parameters:

id - never null

Returns:

return true if the shift was removed, false otherwise