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

Class ForecastResourceDetailService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.forecastcapacity.rs1.forecast.resource.detail.ForecastResourceDetailService

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

Services to manage a BOForecastResourceDetail object.

Since:

15.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
ForecastResourceDetailService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	delete(Long forecastHeaderId, Long id)	Deletes the required BOForecastResourceDetail object by calling the ForecastResourceDetailDeleteEvent event
org.springframework.http.ResponseEntity<DTOForecastResourceDetail>	get(Long forecastHeaderId, Long id, Collection<String> fields)	Retrieves the required BOForecastResourceDetail object by calling the ForecastResourceDetailLoadEvent event
org.springframework.http.ResponseEntity<PageResponse<DTOForecastResourceDetail>>	getCollection(Long forecastHeaderId, @Valid Page page, String order, Collection<String> fields, @Valid DTOForecastResourceDetailSearchFilter filter)	Returns the collection of all the stored BOForecastResourceDetail objects by calling the ForecastResourceDetailSearchEvent event
org.springframework.http.ResponseEntity<Void>	patch(Long forecastHeaderId, Long id, @Valid DTOForecastResourceDetailUpdate dto)	Updates the required BOForecastResourceDetail object by calling the ForecastResourceDetailUpdateEvent event
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(Long forecastHeaderId, @Valid DTOForecastResourceDetailInsert dto)	Creates a new BOForecastResourceDetail object by calling the ForecastResourceDetailInsertEvent event

Methods inherited from class java.lang.Object

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

Constructor Details

ForecastResourceDetailService

public ForecastResourceDetailService()

Method Details

getCollection

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

Returns the collection of all the stored BOForecastResourceDetail objects by calling the ForecastResourceDetailSearchEvent event

Parameters:

forecastHeaderId - the BOForecastResource object's forecastHeader field

page - the page

order - the order

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

filter - the DTOForecastResourceDetailSearchFilter object

Returns:

the collection of DTOForecastResourceDetails

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required BOForecastResourceDetail object by calling the ForecastResourceDetailLoadEvent event

Parameters:

forecastHeaderId - the BOForecastResourceDetail's forecastHeader field

id - the BOForecastResourceDetail's id field

fields - the collection of fields the response will contain

Returns:

the response containing the loaded DTOForecastResourceDetail

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

Creates a new BOForecastResourceDetail object by calling the ForecastResourceDetailInsertEvent event

Parameters:

forecastHeaderId - the BOForecastResourceDetail's forecastHeader field

dto - the DTOForecastResourceDetailInsert object

Returns:

the response containing the ID of the newly created BOForecastResourceDetail

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

Updates the required BOForecastResourceDetail object by calling the ForecastResourceDetailUpdateEvent event

Parameters:

forecastHeaderId - the BOForecastActivity object's forecastHeader field

id - id of the BOForecastResourceDetail object to update

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

Deletes the required BOForecastResourceDetail object by calling the ForecastResourceDetailDeleteEvent event

Parameters:

forecastHeaderId - the BOForecastResourceDetail's forecastHeader field

id - the id of the BOForecastResourceDetail object to be deleted

Returns:

the DTO response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception