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

Class ForecastResourceService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.forecastcapacity.rs1.forecast.resource.forecastresource.ForecastResourceService

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

Services to manage a BOForecastResource object.

Since:

15.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
ForecastResourceService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	delete(Long forecastHeaderId, Long id)	Deletes the required BOForecastResource object from a given BOResourceForecastHeader object by calling the ForecastResourceDeleteEvent
org.springframework.http.ResponseEntity<DTOForecastResource>	get(Long forecastHeaderId, Long id, Collection<String> fields)	Retrieves the required BOForecastResource object by calling the ForecastResourceLoadEvent event
org.springframework.http.ResponseEntity<PageResponse<DTOForecastResource>>	getCollection(Long forecastHeaderId, @Valid Page page, String order, Collection<String> fields, @Valid DTOForecastResourceSearchFilter filter)	Returns the collection of all the stored BOForecastResource objects by calling the ForecastResourceSearchEvent event
org.springframework.http.ResponseEntity<Void>	importFromOc(Long forecastHeaderId, @Valid DTOForecastResourceImportFromCO dto)	Import a real resource as a BOForecastResource object by calling the ForecastResourceImportFromOCEvent event
org.springframework.http.ResponseEntity<Void>	patch(Long forecastHeaderId, Long id, @Valid DTOForecastResourceUpdate dto)	Updates a BOForecastResource object by calling the ForecastResourceUpdateEvent event
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(Long forecastHeaderId, @Valid DTOForecastResourceInsert dto)	Creates a new BOForecastResource object by calling the ForecastResourceInsertEvent event

Methods inherited from class java.lang.Object

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

Constructor Details

ForecastResourceService

public ForecastResourceService()

Method Details

getCollection

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

Returns the collection of all the stored BOForecastResource objects by calling the ForecastResourceSearchEvent 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 DTOForecastResourceSearchFilter object

Returns:

the collection of DTOForecastResources

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required BOForecastResource object by calling the ForecastResourceLoadEvent event

Parameters:

forecastHeaderId - the BOForecastResource object's forecastHeader field

id - the BOForecastResource object's id field

fields - the collection of fields the response will contain

Returns:

the response containing the loaded DTOForecastResource

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

Creates a new BOForecastResource object by calling the ForecastResourceInsertEvent event

Parameters:

forecastHeaderId - the BOForecastResource's forecastHeader field

dto - the DTOForecastResourceInsert object

Returns:

the response containing the ID of the newly created BOForecastResource

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patch

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

Updates a BOForecastResource object by calling the ForecastResourceUpdateEvent event

Parameters:

forecastHeaderId - the BOForecastResource object's forecastHeader field

id - id of the BOForecastResource object to update

dto - the DTOForecastResourceUpdate object

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

importFromOc

@PostMapping(value="import-from-operation-centers",
             consumes="application/json",
             produces="application/json")
public org.springframework.http.ResponseEntity<Void> importFromOc(@PathVariable("resourceForecastId")
 Long forecastHeaderId,
 @Valid @RequestBody
 @Valid DTOForecastResourceImportFromCO dto)
                                                           throws DAValidateException,
DAException

Import a real resource as a BOForecastResource object by calling the ForecastResourceImportFromOCEvent event

Parameters:

forecastHeaderId - the BOForecastResource object's forecastHeader field

dto - the DTOForecastResourceImportFromCO object

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

delete

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

Deletes the required BOForecastResource object from a given BOResourceForecastHeader object by calling the ForecastResourceDeleteEvent

Parameters:

forecastHeaderId - the BOForecastResource's forecastHeader field

id - the id of the BOForecastResource object to be deleted

Returns:

the DTO response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception