org.optaweb.employeerostering.shared.employee

Interface EmployeeRestService

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

Method Summary

Modifier and Type	Method and Description
Employee	addEmployee(Integer tenantId, Employee employee)
EmployeeAvailabilityView	addEmployeeAvailability(Integer tenantId, EmployeeAvailabilityView employeeAvailability)
Employee	getEmployee(Integer tenantId, Long id)
List<Employee>	getEmployeeList(Integer tenantId)
Boolean	removeEmployee(Integer tenantId, Long id)
Boolean	removeEmployeeAvailability(Integer tenantId, Long id)
Employee	updateEmployee(Integer tenantId, Employee employee)
EmployeeAvailabilityView	updateEmployeeAvailability(Integer tenantId, EmployeeAvailabilityView employeeAvailability)

Method Detail

getEmployeeList

@GET
 @Path(value="/")
List<Employee> getEmployeeList(@PathParam(value="tenantId")
                                                      Integer tenantId)

getEmployee

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

Parameters:

id - never null

Returns:

never null, the employee with the id

addEmployee

@POST
 @Path(value="/add")
Employee addEmployee(@PathParam(value="tenantId")
                                                Integer tenantId,
                                                Employee employee)

Parameters:

employee - never null

Returns:

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

updateEmployee

@POST
 @Path(value="/update")
Employee updateEmployee(@PathParam(value="tenantId")
                                                      Integer tenantId,
                                                      Employee employee)

Parameters:

employee - never null

Returns:

never null, with an updated AbstractPersistable.getVersion()

removeEmployee

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

Parameters:

id - never null

Returns:

true if the employee was removed, false otherwise

addEmployeeAvailability

@POST
 @Path(value="/availability/add")
EmployeeAvailabilityView addEmployeeAvailability(@PathParam(value="tenantId")
                                                                                         Integer tenantId,
                                                                                         EmployeeAvailabilityView employeeAvailability)

Parameters:

employeeAvailability - never null

Returns:

never null, the id

updateEmployeeAvailability

@PUT
 @Path(value="/availability/update")
EmployeeAvailabilityView updateEmployeeAvailability(@PathParam(value="tenantId")
                                                                                              Integer tenantId,
                                                                                              EmployeeAvailabilityView employeeAvailability)

Parameters:

employeeAvailability - never null

removeEmployeeAvailability

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

Parameters:

id - never null

Returns:

never null, the id