Package overit.geocallapp.wfm.forecastcapacity.rs1.forecast.common.state

Class ForecastHeaderStateService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.forecastcapacity.rs1.forecast.common.state.ForecastHeaderStateService

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

Services to manage a BOForecastState object.

Since:

15.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
ForecastHeaderStateService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOForecastState>	get(Long id, String language, Collection<String> fields)	Retrieves the required BOForecastState object by calling from the ForecastStateLoadEvent event
org.springframework.http.ResponseEntity<PageResponse<DTOForecastState>>	getCollection(@Valid Page page, String order, String language, Collection<String> fields, @Valid DTOForecastStateSearchFilter filter)	Returns the collection of all the stored BOForecastState objects by calling the ForecastStateSearchEvent event

Methods inherited from class java.lang.Object

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

Constructor Details

ForecastHeaderStateService

public ForecastHeaderStateService()

Method Details

getCollection

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

Returns the collection of all the stored BOForecastState objects by calling the ForecastStateSearchEvent event

Parameters:

page - the page

order - the order

language - the language of the user

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

filter - the DTOForecastStateSearchFilter object

Returns:

the collection of DTOForecastStates

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required BOForecastState object by calling from the ForecastStateLoadEvent event

Parameters:

id - the BOForecastState object's id field

language - the language of the user

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

Returns:

the response containing the loaded DTOForecastState

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception is thrown