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

Class ResourceForecastHeaderService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.forecastcapacity.rs1.forecast.resource.ResourceForecastHeaderService

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

Services to manage a BOResourceForecastHeader object.

Since:

15.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
ResourceForecastHeaderService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	delete(Long id)	Logically cancels the required id of BOResourceForecastHeader by calling the ResourceForecastHeaderCancelEvent event
org.springframework.http.ResponseEntity<DTOResourceForecastHeader>	get(Long id, Collection<String> fields)	Retrieves the required BOResourceForecastHeader object by calling the ResourceForecastHeaderLoadEvent event
org.springframework.http.ResponseEntity<PageResponse<DTOResourceForecastHeader>>	getCollection(@Valid Page page, String order, Collection<String> fields, @Valid DTOResourceForecastHeaderSearchFilter filter)	Returns the collection of all the stored BOResourceForecastHeader objects by calling the ResourceForecastHeaderSearchEvent event
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(@Valid DTOResourceForecastHeaderInsert dto)	Creates a new BOResourceForecastHeader object by calling the ResourceForecastHeaderInsertEvent event

Methods inherited from class java.lang.Object

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

Constructor Details

ResourceForecastHeaderService

public ResourceForecastHeaderService()

Method Details

getCollection

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

Returns the collection of all the stored BOResourceForecastHeader objects by calling the ResourceForecastHeaderSearchEvent event

Parameters:

page - the page

order - the order

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

filter - the DTOResourceForecastHeaderSearchFilter object

Returns:

the collection of DTOResourceForecastHeaders

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required BOResourceForecastHeader object by calling the ResourceForecastHeaderLoadEvent event

Parameters:

id - the BOResourceForecastHeader object's id field

fields - the collection of fields the response will contain

Returns:

the response containing the loaded DTOResourceForecastHeader

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

Creates a new BOResourceForecastHeader object by calling the ResourceForecastHeaderInsertEvent event

Parameters:

dto - the DTOResourceForecastHeaderInsert object

Returns:

the response containing the ID of the newly created BOResourceForecastHeader

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

delete

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

Logically cancels the required id of BOResourceForecastHeader by calling the ResourceForecastHeaderCancelEvent event

Parameters:

id - the id of the DTOResourceForecastHeader object to be logically cancelled

Returns:

the DTO response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception