Package overit.geocallapp.wfm.skills.rs1.skill

Class SkillService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.skills.rs1.skill.SkillService

@RestController
@RequestMapping("workforce/skills/r1/skills")
@Resource(logging=true)
public class SkillService
extends PrivateService

Service for manage skill

Since:

16.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
SkillService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOSkill>	get(Long skillId, Collection<String> fields)	Retrieves the required DTOSkill by calling the SkillLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOSkill>>	getCollection(@Valid Page page, Collection<String> fields, String order, @Valid DTOSkillFilter filter)	Returns the collection of all the stored skills by calling the SkillSearchEvent.
org.springframework.http.ResponseEntity<Void>	patch(Long skillId, @Valid DTOSkillUpdate dto)	Update a skill by calling the SkillUpdateEvent
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(@Valid DTOSkillInsert dto)	Create a new skill by calling the SkillInsertEvent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SkillService

public SkillService()

Method Details

getCollection

@GetMapping(produces="application/json")
public org.springframework.http.ResponseEntity<PageResponse<DTOSkill>> getCollection(@RequestParam("_page") @Valid
 @Valid Page page,
 @RequestParam(required=false,value="_fields")
 Collection<String> fields,
 @RequestParam(required=false,value="_order")
 String order,
 @Valid
 @Valid DTOSkillFilter filter)
                                                                              throws DAValidateException,
DAException

Returns the collection of all the stored skills by calling the SkillSearchEvent.

Parameters:

page - the Page that will contain the paginated result

fields - the collection of fields the response will contain

order - the ordering field

filter - the DTOSkill

Returns:

the collection of DTOSkill

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

@GetMapping(value="{skillId:[0-9]+}",
            produces="application/json")
public org.springframework.http.ResponseEntity<DTOSkill> get(@PathVariable("skillId")
 Long skillId,
 @RequestParam(required=false,value="_fields")
 Collection<String> fields)
                                                      throws DAValidateException,
DAException

Retrieves the required DTOSkill by calling the SkillLoadEvent.

Parameters:

skillId - the skill id

fields - the collection of fields the response will contain

Returns:

the response containing the loaded skill

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

post

@PostMapping(consumes="application/json",
             produces="application/json")
public org.springframework.http.ResponseEntity<DTOIdentifier<Long>> post(@Valid @RequestBody
 @Valid DTOSkillInsert dto)
                                                                  throws DAValidateException,
DAException

Create a new skill by calling the SkillInsertEvent

Parameters:

dto - the DTOSkill

Returns:

the standard response containing the new skill id

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patch

@PatchMapping(value="{skillId:[0-9]+}",
              consumes="application/json",
              produces="application/json")
public org.springframework.http.ResponseEntity<Void> patch(@PathVariable("skillId")
 Long skillId,
 @Valid @RequestBody
 @Valid DTOSkillUpdate dto)
                                                    throws DAValidateException,
DAException

Update a skill by calling the SkillUpdateEvent

Parameters:

skillId - the skill id

dto - the DTOSkill

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception