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

Class ActivityForecastSkillService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.forecastcapacity.rs1.forecast.activity.skill.ActivityForecastSkillService

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

Services to manage a BOForecastActivitySkill object.

Since:

15.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
ActivityForecastSkillService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	delete(Long forecastHeaderId, Long id)	Deletes the required BOForecastActivitySkill object from a given BOActivityForecastHeader object by calling the ForecastActivitySkillDeleteEvent event
org.springframework.http.ResponseEntity<DTOActivityForecastSkill>	get(Long forecastHeaderId, Long id, Collection<String> fields)	Retrieves the required BOForecastActivitySkill object by calling the ForecastActivitySkillLoadEvent event
org.springframework.http.ResponseEntity<PageResponse<DTOActivityForecastSkill>>	getCollection(@Valid Page page, String order, Collection<String> fields, Long forecastHeaderId, @Valid DTOActivityForecastSkillSearchFilter filter)	Retrieves the collection of all the stored BOForecastActivitySkill objects by calling the ForecastActivitySkillSearchEvent event
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(Long forecastHeaderId, @Valid DTOActivityForecastSkillInsert dto)	Creates a new BOForecastActivitySkill object by calling the ForecastActivitySkillInsertEvent event

Methods inherited from class java.lang.Object

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

Constructor Details

ActivityForecastSkillService

public ActivityForecastSkillService()

Method Details

getCollection

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

Retrieves the collection of all the stored BOForecastActivitySkill objects by calling the ForecastActivitySkillSearchEvent event

Parameters:

forecastHeaderId - the BOForecastActivitySkill object 's forecastHeader field

filter - the DTOActivityForecastSkillSearchFilter 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<DTOActivityForecastSkill> get(@PathVariable("activityForecastId")
 Long forecastHeaderId,
 @PathVariable("skillId")
 Long id,
 @RequestParam(required=false,value="_fields")
 Collection<String> fields)
                                                                      throws DAValidateException,
DAException

Retrieves the required BOForecastActivitySkill object by calling the ForecastActivitySkillLoadEvent event

Parameters:

forecastHeaderId - the BOForecastActivitySkill's forecastHeader field

id - the BOForecastActivitySkill object's id field

Returns:

the response containing the loaded DTOActivityForecastSkill

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

Creates a new BOForecastActivitySkill object by calling the ForecastActivitySkillInsertEvent event

Parameters:

forecastHeaderId - the BOForecastActivitySkill object 's forecastHeader field

dto - the DTOActivityForecastSkillInsert object

Returns:

the response containing the ID of the newly created BOForecastActivitySkill

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

Deletes the required BOForecastActivitySkill object from a given BOActivityForecastHeader object by calling the ForecastActivitySkillDeleteEvent event

Parameters:

forecastHeaderId - the BOForecastActivitySkill object 's forecastHeader field

id - the id of the BOForecastActivitySkill object to delete

Returns:

the DTO response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception