org.optaweb.employeerostering.shared.skill

Interface SkillRestService

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

Method Summary

Modifier and Type	Method and Description
Skill	addSkill(Integer tenantId, Skill skill)
Skill	getSkill(Integer tenantId, Long id)
List<Skill>	getSkillList(Integer tenantId)
Boolean	removeSkill(Integer tenantId, Long id)
Skill	updateSkill(Integer tenantId, Skill skill)

Method Detail

getSkillList

@GET
 @Path(value="/")
List<Skill> getSkillList(@PathParam(value="tenantId")
                                                Integer tenantId)

getSkill

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

Parameters:

id - never null

Returns:

never null, the id

addSkill

@POST
 @Path(value="/add")
Skill addSkill(@PathParam(value="tenantId")
                                          Integer tenantId,
                                          Skill skill)

Parameters:

skill - never null

Returns:

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

updateSkill

@POST
 @Path(value="/update")
Skill updateSkill(@PathParam(value="tenantId")
                                                Integer tenantId,
                                                Skill skill)

Parameters:

skill - never null

Returns:

never null, with an updated AbstractPersistable.getVersion()

removeSkill

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

Parameters:

id - never null

Returns:

true if the skill was successfully removed, false otherwise