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

Class ForecastShiftModelService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.forecastcapacity.rs1.forecast.resource.shiftmodel.ForecastShiftModelService

@RestController
@RequestMapping("planning/forecast-capacity/r1/resource-forecasts/shift-models")
@Resource(logging=true)
public class ForecastShiftModelService
extends PrivateService

Services to manage a BOForecastShiftModel object.

Since:

15.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
ForecastShiftModelService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOForecastShiftModel>	get(Long id, Collection<String> fields)	Retrieves the required BOForecastShiftModel object by calling the ForecastShiftModelLoadEvent event
org.springframework.http.ResponseEntity<PageResponse<DTOForecastShiftModel>>	getCollection(@Valid Page page, String order, Collection<String> fields, @Valid DTOForecastShiftModelSearchFilter filter)	Returns the collection of all the stored BOForecastShiftModel objects by calling the ForecastShiftModelSearchEvent event
org.springframework.http.ResponseEntity<Void>	patch(Long id, @Valid DTOForecastShiftModelUpdate dto)	Updates the required BOForecastShiftModel object by calling the ForecastShiftModelUpdateEvent event
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(@Valid DTOForecastShiftModelInsert dto)	Creates a new BOForecastShiftModel object by calling the ForecastShiftModelInsertEvent event Automatically creates N rows, i.e.

Methods inherited from class java.lang.Object

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

Constructor Details

ForecastShiftModelService

public ForecastShiftModelService()

Method Details

getCollection

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

Returns the collection of all the stored BOForecastShiftModel objects by calling the ForecastShiftModelSearchEvent event

Parameters:

page - the page

order - the order

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

filter - the DTOForecastShiftModelSearchFilter object

Returns:

the collection of DTOForecastShiftModels

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required BOForecastShiftModel object by calling the ForecastShiftModelLoadEvent event

Parameters:

id - the BOForecastShiftModel object's id

fields - the collection of fields the response will contain

Returns:

the response containing the loaded DTOForecastShiftModel

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(@Valid @RequestBody
 @Valid DTOForecastShiftModelInsert dto)
                                                                  throws DAValidateException,
DAException

Creates a new BOForecastShiftModel object by calling the ForecastShiftModelInsertEvent event Automatically creates N rows, i.e. BOForecastShiftModelDetail objects, where N is the duration of the DTOForecastShiftModelInsert object

Parameters:

dto - the DTOForecastShiftModelInsert object

Returns:

the response containing the ID of the newly created BOForecastShiftModel

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patch

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

Updates the required BOForecastShiftModel object by calling the ForecastShiftModelUpdateEvent event

Parameters:

id - the id of the BOForecastShiftModel object to be updated

dto - the DTOForecastShiftModelUpdate object

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception