Package overit.geocallapp.wfm.skills.rs1.skillconfiguration

Class SkillConfigurationService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.skills.rs1.skillconfiguration.SkillConfigurationService

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

Service to manage skill configurations.

Since:

17.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
SkillConfigurationService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOSkillConfiguration>	get(Long id, String language, Collection<String> fields)	Retrieves the required skill configuration by calling the SkillConfigurationLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOSkillConfiguration>>	getCollection(@Valid Page page, String order, String language, Collection<String> fields, @Valid DTOSkillConfigurationFilter filter)	Returns the collection of all the stored skill configurations by calling the SkillConfigurationSearchEvent.
org.springframework.http.ResponseEntity<Void>	patch(Long id, @Valid DTOSkillConfigurationUpdate input)	Updates the required skill configuration by calling the SkillConfigurationUpdateEvent.
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(@Valid DTOSkillConfigurationInsert input)	Creates a new skill configuration by calling the SkillConfigurationInsertEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

SkillConfigurationService

public SkillConfigurationService()

Method Details

getCollection

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

Returns the collection of all the stored skill configurations by calling the SkillConfigurationSearchEvent.

Parameters:

page - the page that will contain the paginated result

order - the ordering field

language - the user language

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

filter - the DTOSkillConfigurationFilter

Returns:

the collection of DTOSkillConfigurations

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception is thrown

get

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

Retrieves the required skill configuration by calling the SkillConfigurationLoadEvent.

Parameters:

id - the ID of the skill configuration to be loaded

language - the user language

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

Returns:

the response containing the loaded skill configuration

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception is thrown

post

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

Creates a new skill configuration by calling the SkillConfigurationInsertEvent.

Parameters:

input - the DTOSkillConfigurationInsert

Returns:

the response containing the ID of the newly created skill configuration

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception is thrown

patch

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

Updates the required skill configuration by calling the SkillConfigurationUpdateEvent.

Parameters:

id - the ID of the skill configuration to be updated

input - the DTOSkillConfigurationUpdate

Returns:

the standard response

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception is thrown