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

Class ForecastActivityDetailService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.forecastcapacity.rs1.forecast.activity.detail.ForecastActivityDetailService

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

Services to manage a BOForecastActivityDetail object.

Since:

15.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
ForecastActivityDetailService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	delete(Long forecastHeaderId, Long detailId)	Deletes the required BOForecastActivityDetail object from a given BOActivityForecastHeader object by calling the ForecastActivityDetailDeleteEvent event
org.springframework.http.ResponseEntity<DTOForecastActivityDetail>	get(Long forecastHeaderId, Long detailId, Collection<String> fields)	Retrieves the required BOForecastActivityDetail object by calling the ForecastActivityDetailLoadEvent event
org.springframework.http.ResponseEntity<PageResponse<DTOForecastActivityDetail>>	getCollection(@Valid Page page, String order, Collection<String> fields, Long forecastHeaderId, @Valid DTOForecastActivityDetailSearchFilter filter)	Returns the collection of all the stored BOForecastActivityDetail objects by calling the ForecastActivityDetailLoadEvent event
org.springframework.http.ResponseEntity<Void>	patch(Long forecastHeaderId, Long detailId, @Valid DTOForecastActivityDetailUpdate dto)	Updates the required BOForecastActivityDetail object by calling the ForecastActivityDetailUpdateEvent event
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(Long forecastHeaderId, @Valid DTOForecastActivityDetailInsert dto)	Create a new BOForecastActivityDetail object by calling the ForecastActivityDetailInsertEvent event

Methods inherited from class java.lang.Object

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

Constructor Details

ForecastActivityDetailService

public ForecastActivityDetailService()

Method Details

getCollection

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

Returns the collection of all the stored BOForecastActivityDetail objects by calling the ForecastActivityDetailLoadEvent event

Parameters:

forecastHeaderId - the BOForecastActivityDetail's forecastHeader field

filter - the DTOForecastActivityDetailSearchFilter object

Returns:

the collection of DTOForecastActivityDetails

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required BOForecastActivityDetail object by calling the ForecastActivityDetailLoadEvent event

Parameters:

forecastHeaderId - the BOForecastActivityDetail's forecastHeader field

detailId - the BOForecastActivityDetail's id field

Returns:

the response containing the loaded DTOCapacityPlanningScenario

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 DTOForecastActivityDetailInsert dto)
                                                                  throws DAValidateException,
DAException

Create a new BOForecastActivityDetail object by calling the ForecastActivityDetailInsertEvent event

Parameters:

forecastHeaderId - the BOForecastActivityDetail's forecastHeader field

dto - the DTOForecastActivityDetailInsert object

Returns:

the response containing the ID of the newly created BOForecastActivityDetail

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patch

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

Updates the required BOForecastActivityDetail object by calling the ForecastActivityDetailUpdateEvent event

Parameters:

forecastHeaderId - the BOForecastActivity object's forecastHeader field

detailId - id of the BOForecastActivityDetail object to update

dto - the DTOForecastActivityDetailUpdate object

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

delete

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

Deletes the required BOForecastActivityDetail object from a given BOActivityForecastHeader object by calling the ForecastActivityDetailDeleteEvent event

Parameters:

forecastHeaderId - the BOForecastActivityDetail's forecastHeader field

detailId - the id of the BOForecastActivityDetail object to be deleted

Returns:

the DTO response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception