Package overit.geocallapp.wfm.skills.rs1.skillconfigurationdivision

Class SkillConfigurationDivisionService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.skills.rs1.skillconfigurationdivision.SkillConfigurationDivisionService

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

Service to manage skill configuration divisions.

Since:

17.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
SkillConfigurationDivisionService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	delete(Long configurationId, Long divisionId)	Deletes all the DTOSkillDivisionSkill relation related to the given skill division id and skill id.
org.springframework.http.ResponseEntity<DTOSkillConfigurationDivision>	get(Long configurationId, Long divisionId, Collection<String> fields)	Retrieves the required skill configuration division by calling the SkillConfigurationDivisionLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOSkillConfigurationDivision>>	getCollection(Long configurationId, @Valid Page page, Collection<String> fields, String order, @Valid DTOSkillConfigurationDivisionFilter filter)	Returns the collection of all the stored skill configuration divisions by calling the SkillConfigurationDivisionSearchEvent.
org.springframework.http.ResponseEntity<Void>	post(Long configurationId, @Valid DTOSkillConfigurationDivisionInsert input)	Creates a new skill configuration division by calling the SkillConfigurationDivisionInsertEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

SkillConfigurationDivisionService

public SkillConfigurationDivisionService()

Method Details

getCollection

@GetMapping(produces="application/json")
public org.springframework.http.ResponseEntity<PageResponse<DTOSkillConfigurationDivision>> 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 DTOSkillConfigurationDivisionFilter filter)
                                                                                                   throws DAValidateException,
DAException

Returns the collection of all the stored skill configuration divisions by calling the SkillConfigurationDivisionSearchEvent.

Parameters:

configurationId - the ID of the skill division related to the skill configuration divisions to be searched

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 DTOSkillConfigurationDivisionFilter

Returns:

the collection of DTOSkillConfigurationDivisions

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception is thrown

get

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

Retrieves the required skill configuration division by calling the SkillConfigurationDivisionLoadEvent.

Parameters:

configurationId - the ID of the skill division related to the skill configuration division to be loaded

divisionId - the ID of the skill configuration division to be loaded

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

Returns:

the response containing the loaded skill configuration division

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

Creates a new skill configuration division by calling the SkillConfigurationDivisionInsertEvent.

Parameters:

configurationId - the ID of the skill division related to the skill configuration division to be inserted

input - the DTOSkillConfigurationDivisionInsert

Returns:

the response containing the ID of the newly created skill configuration division

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception is thrown

delete

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

Deletes all the DTOSkillDivisionSkill relation related to the given skill division id and skill id.

Parameters:

configurationId - the skill configuration id

divisionId - the division id

Returns:

the response entity

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception