Package overit.geocallapp.wfm.forecastcapacity.rs1.forecast.resource.skill

Class ResourceForecastSkillService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.forecastcapacity.rs1.forecast.resource.skill.ResourceForecastSkillService

@RestController
@RequestMapping("planning/forecast-capacity/r1/resource-forecasts/{resourceForecastId:[0-9]+}/skills")
@Resource(logging=true)
public class ResourceForecastSkillService
extends PrivateService

Services to manage a BOResourceForecastSkill object.

Since:

15.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
ResourceForecastSkillService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	delete(Long forecastHeaderId, Long id)	Deletes the required BOResourceForecastSkill object from a given BOResourceForecastHeader object by calling the ForecastResourceSkillDeleteEvent event
org.springframework.http.ResponseEntity<DTOResourceForecastSkill>	get(Long forecastHeaderId, Long id, Collection<String> fields)	Retrieves the required BOResourceForecastSkill object by calling the ForecastResourceSkillLoadEvent event
org.springframework.http.ResponseEntity<PageResponse<DTOResourceForecastSkill>>	getCollection(Long forecastHeaderId, @Valid Page page, String order, Collection<String> fields, @Valid DTOResourceForecastSkillSearchFilter filter)	Retrieves the collection of all the stored BOResourceForecastSkill object by calling the ForecastResourceSkillSearchEvent event
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(Long forecastHeaderId, @Valid DTOForecastResourceInsert dto)	Creates a new BOResourceForecastSkill object by calling the ForecastResourceSkillInsertEvent event

Methods inherited from class java.lang.Object

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

Constructor Details

ResourceForecastSkillService

public ResourceForecastSkillService()

Method Details

getCollection

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

Retrieves the collection of all the stored BOResourceForecastSkill object by calling the ForecastResourceSkillSearchEvent event

Parameters:

forecastHeaderId - the BOResourceForecastSkill object's forecastHeader field

page - the page

order - the order

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

filter - the DTOResourceForecastSkillSearchFilter object

Returns:

the collection of DTOResourceForecastSkills

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required BOResourceForecastSkill object by calling the ForecastResourceSkillLoadEvent event

Parameters:

forecastHeaderId - the BOResourceForecastSkill object's forecastHeader field

id - the BOResourceForecastSkill object's id field

fields - the collection of fields the response will contain

Returns:

the response containing the loaded DTOForecastResource

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(@PathVariable("resourceForecastId")
 Long forecastHeaderId,
 @Valid @RequestBody
 @Valid DTOForecastResourceInsert dto)
                                                                  throws DAValidateException,
DAException

Creates a new BOResourceForecastSkill object by calling the ForecastResourceSkillInsertEvent event

Parameters:

forecastHeaderId - the BOResourceForecastSkill object's forecastHeader field

dto - the DTOResourceForecastSkillInsert object

Returns:

the response containing the ID of the newly created BOResourceForecastSkill

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("resourceForecastId")
 Long forecastHeaderId,
 @PathVariable("skillId")
 Long id)
                                                     throws DAValidateException,
DAException

Deletes the required BOResourceForecastSkill object from a given BOResourceForecastHeader object by calling the ForecastResourceSkillDeleteEvent event

Parameters:

forecastHeaderId - the BOResourceForecastSkill object's forecastHeader field

id - the id of the BOResourceForecastSkill object to be deleted

Returns:

the DTO response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception