org.optaweb.employeerostering.shared.spot

Interface SpotRestService

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

Method Summary

Modifier and Type	Method and Description
Spot	addSpot(Integer tenantId, Spot spot)
Spot	getSpot(Integer tenantId, Long id)
List<Spot>	getSpotList(Integer tenantId)
Boolean	removeSpot(Integer tenantId, Long id)
Spot	updateSpot(Integer tenantId, Spot spot)

Method Detail

getSpotList

@GET
 @Path(value="/")
List<Spot> getSpotList(@PathParam(value="tenantId")
                                              Integer tenantId)

getSpot

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

Parameters:

id - never null

Returns:

never null, the id

addSpot

@POST
 @Path(value="/add")
Spot addSpot(@PathParam(value="tenantId")
                                        Integer tenantId,
                                        Spot spot)

Parameters:

spot - never null

Returns:

never null, with a AbstractPersistable.getId() that is never null

updateSpot

@POST
 @Path(value="/update")
Spot updateSpot(@PathParam(value="tenantId")
                                              Integer tenantId,
                                              Spot spot)

Parameters:

spot - never null

Returns:

never null, with an updated AbstractPersistable.getVersion()

removeSpot

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

Parameters:

id - never null

Returns:

true if the spot was successfully removed, false otherwise