Package overit.geocallapp.wfm.skills.rs1.skillconfigurationskill

Class SkillConfigurationSkillService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.skills.rs1.skillconfigurationskill.SkillConfigurationSkillService

@RestController
@RequestMapping("workforce/skills/r1/configurations/{configurationId:[0-9]+}/skills")
@Resource(logging=true)
public class SkillConfigurationSkillService
extends PrivateService

Service to manage skill configuration skills.

Since:

17.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
SkillConfigurationSkillService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	delete(Long configurationId, Long skillId)	Deletes all the DTOSkillConfigurationSkill relation related to the given skill configuration id and skill id.
org.springframework.http.ResponseEntity<DTOSkillConfigurationSkill>	get(Long configurationId, Long skillId, Collection<String> fields)	Retrieves the required DTOSkillConfigurationSkill by calling from the SkillConfigurationSkillSearchEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOSkillConfigurationSkill>>	getCollection(Long configurationId, @Valid Page page, Collection<String> fields, String order, @Valid DTOSkillConfigurationSkillFilter filter)	Returns the collection of all the stored DTOSkillConfigurationSkills by calling the SkillConfigurationSkillSearchEvent.
org.springframework.http.ResponseEntity<Void>	patch(Long configurationId, Long skillId, @Valid DTOSkillConfigurationSkillUpdate input)	Updates the required DTOSkillConfigurationSkill relation by calling the SkillConfigurationSkillUpdateEvent.
org.springframework.http.ResponseEntity<Void>	post(Long configurationId, @Valid DTOSkillConfigurationSkillInsert input)	Creates a new DTOSkillConfigurationSkill relation by calling the DTOSkillConfigurationSkillInsert.

Methods inherited from class java.lang.Object

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

Constructor Details

SkillConfigurationSkillService

public SkillConfigurationSkillService()

Method Details

getCollection

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

Returns the collection of all the stored DTOSkillConfigurationSkills by calling the SkillConfigurationSkillSearchEvent.

Parameters:

configurationId - the skill configuration id

page - the Page that will contain the paginated result

fields - the collection of fields that will be contained in the response

order - the ordering field

filter - the DTOSkillConfigurationSkillFilter

Returns:

the collection of DTOSkillConfigurationSkill

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required DTOSkillConfigurationSkill by calling from the SkillConfigurationSkillSearchEvent.

Parameters:

configurationId - the skill configuration id

skillId - the skill id

fields - the collection of fields that will be contained in the response

Returns:

the response containing the loaded skill configuration skill

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

post

@PostMapping(consumes="application/json",
             produces="application/json")
public org.springframework.http.ResponseEntity<Void> post(@PathVariable("configurationId")
 Long configurationId,
 @Valid @RequestBody
 @Valid DTOSkillConfigurationSkillInsert input)
                                                   throws DAValidateException,
DAException

Creates a new DTOSkillConfigurationSkill relation by calling the DTOSkillConfigurationSkillInsert.

Parameters:

configurationId - the skill configuration id

input - the DTOSkillConfigurationSkillInsert

Returns:

the response entity

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("configurationId")
 Long configurationId,
 @PathVariable("skillId")
 Long skillId,
 @Valid @RequestBody
 @Valid DTOSkillConfigurationSkillUpdate input)
                                                    throws DAValidateException,
DAException

Updates the required DTOSkillConfigurationSkill relation by calling the SkillConfigurationSkillUpdateEvent.

Parameters:

configurationId - the skill configuration id

skillId - the skill id

input - the DTOSkillConfigurationSkillUpdate

Returns:

the response entity

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

delete

@DeleteMapping(value="{skillId:[0-9]+}",
               produces="application/json")
public org.springframework.http.ResponseEntity<Void> delete(@PathVariable("configurationId")
 Long configurationId,
 @PathVariable("skillId")
 Long skillId)
                                                     throws DAValidateException,
DAException

Deletes all the DTOSkillConfigurationSkill relation related to the given skill configuration id and skill id.

Parameters:

configurationId - the configuration id

skillId - the skill id

Returns:

the response entity

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception