org.optaweb.employeerostering.shared.tenant

Interface TenantRestService

@Path(value="/tenant")
 @Produces(value="application/json")
 @Consumes(value="application/json")
 @GenRestBuilder
public interface TenantRestService

Method Summary

Modifier and Type	Method and Description
Tenant	addTenant(RosterState intialRosterState)
RosterParametrization	getRosterParametrization(Integer id)
List<ZoneId>	getSupportedTimezones()
Tenant	getTenant(Integer id)
List<Tenant>	getTenantList()
Boolean	removeTenant(Integer id)
RosterParametrization	updateRosterParametrization(RosterParametrization rosterParametrization)

Method Detail

getTenantList

@GET
 @Path(value="/")
List<Tenant> getTenantList()

getTenant

@GET
 @Path(value="/{id : \\d+}")
Tenant getTenant(@PathParam(value="id")
                                                   Integer id)

Parameters:

id - never null

Returns:

never null, the id

addTenant

@POST
 @Path(value="/add")
Tenant addTenant(RosterState intialRosterState)

Parameters:

tenant - never null

Returns:

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

removeTenant

@POST
 @Path(value="/remove/{id}")
Boolean removeTenant(@PathParam(value="id")
                                                        Integer id)

getRosterParametrization

@GET
 @Path(value="/{id}")
RosterParametrization getRosterParametrization(@PathParam(value="id")
                                                                          Integer id)

Parameters:

id - never null

Returns:

never null, the id

updateRosterParametrization

@POST
 @Path(value="/parametrization/update")
RosterParametrization updateRosterParametrization(RosterParametrization rosterParametrization)

getSupportedTimezones

@GET
 @Path(value="/supported/timezones")
List<ZoneId> getSupportedTimezones()