Package overit.geocallapp.wfm.forecastcapacity.rs1.forecast.resource.shiftmodel.detail

Class ForecastShiftModelDetailService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.forecastcapacity.rs1.forecast.resource.shiftmodel.detail.ForecastShiftModelDetailService

@RestController
@RequestMapping("planning/forecast-capacity/r1/resource-forecasts/shift-models/{modelId:[0-9]+}/details")
@Resource(logging=true)
public class ForecastShiftModelDetailService
extends PrivateService

Services to manage a BOForecastShiftModelDetail object, i.e., a row of an existing BOForecastShiftModel object.

Since:

15.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
ForecastShiftModelDetailService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOForecastShiftModelDetail>	get(Long forecastShiftModelId, Long id, Collection<String> fields)	Retrieves the required BOForecastShiftModelDetail object (i.e., the row of an existing shift model) by calling the ForecastShiftModelDetailLoadEvent event
org.springframework.http.ResponseEntity<PageResponse<DTOForecastShiftModelDetail>>	getCollection(Long forecastShiftModelId, @Valid Page page, String order, Collection<String> fields, @Valid DTOForecastShiftModelDetailSearchFilter filter)	Returns the collection of all the stored BOForecastShiftModelDetail objects (i.e., the rows of an existing shift model) by calling the ForecastShiftModelDetailSearchEvent event
org.springframework.http.ResponseEntity<Void>	patch(Long forecastShiftModelId, Long id, @Valid DTOForecastShiftModelDetailUpdate dto)	Updates the required row BOForecastShiftModelDetail object (i.e., the row of an existing shift model) by calling the ForecastShiftModelDetailUpdateEvent event

Methods inherited from class java.lang.Object

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

Constructor Details

ForecastShiftModelDetailService

public ForecastShiftModelDetailService()

Method Details

getCollection

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

Returns the collection of all the stored BOForecastShiftModelDetail objects (i.e., the rows of an existing shift model) by calling the ForecastShiftModelDetailSearchEvent event

Parameters:

forecastShiftModelId - the BOForecastShiftModelDetail object's forecastShiftModel field

page - the page

order - the order

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

filter - the DTOForecastShiftModelDetailSearchFilter object

Returns:

the collection of DTOForecastShiftModelDetails

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required BOForecastShiftModelDetail object (i.e., the row of an existing shift model) by calling the ForecastShiftModelDetailLoadEvent event

Parameters:

forecastShiftModelId - the BOForecastShiftModelDetail object's forecastShiftModel field

id - the BOForecastShiftModelDetail object's id

fields - the collection of fields the response will contain

Returns:

the response containing the loaded DTOForecastShiftModelDetail

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("modelId")
 Long forecastShiftModelId,
 @PathVariable("detailId")
 Long id,
 @Valid @RequestBody
 @Valid DTOForecastShiftModelDetailUpdate dto)
                                                    throws DAValidateException,
DAException

Updates the required row BOForecastShiftModelDetail object (i.e., the row of an existing shift model) by calling the ForecastShiftModelDetailUpdateEvent event

Parameters:

forecastShiftModelId - the BOForecastShiftModelDetail object's forecastShiftModel field

id - the BOForecastShiftModelDetail object to be updated

dto - the DTOForecastShiftModelDetail object

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception