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

Class ForecastGroupingConstraintService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.forecastcapacity.rs1.forecast.groupingconstraint.ForecastGroupingConstraintService

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

Services to manage a BOForecastGroupingConstraint object.

Since:

15.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
ForecastGroupingConstraintService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	delete(Long id)	Disable the required BOForecastGroupingConstraint object by calling the ForecastGroupingConstraintDisableEvent event
org.springframework.http.ResponseEntity<DTOForecastGroupingConstraint>	get(Long id, Collection<String> fields)	Retrieves the required BOForecastGroupingConstraint object by calling the ForecastGroupingConstraintLoadEvent event
org.springframework.http.ResponseEntity<PageResponse<DTOForecastGroupingConstraint>>	getCollection(@Valid Page page, String order, Collection<String> fields, @Valid DTOForecastGroupingConstraintSearchFilter filter)	Returns the collection of all the stored BOForecastGroupingConstraint objects by calling the ForecastGroupingConstraintSearchEvent event
org.springframework.http.ResponseEntity<Void>	patch(Long id, @Valid DTOForecastGroupingConstraintUpdate dto)	Updates the required BOForecastGroupingConstraint object by calling the ForecastGroupingConstraintUpdateEvent event
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(@Valid DTOForecastGroupingConstraintInsert dto)	Creates a new BOForecastGroupingConstraint object by calling the ForecastGroupingConstraintInsertEvent event

Methods inherited from class java.lang.Object

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

Constructor Details

ForecastGroupingConstraintService

public ForecastGroupingConstraintService()

Method Details

getCollection

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

Returns the collection of all the stored BOForecastGroupingConstraint objects by calling the ForecastGroupingConstraintSearchEvent event

Parameters:

page - the page

order - the order

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

filter - the DTOForecastGroupingConstraintSearchFilter object

Returns:

the collection of DTOForecastGroupingConstraints

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required BOForecastGroupingConstraint object by calling the ForecastGroupingConstraintLoadEvent event

Parameters:

id - the BOForecastGroupingConstraint object's id field

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

Returns:

the response containing the loaded DTOForecastGroupingConstraint

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception is thrown

post

@PostMapping(consumes="application/json",
             produces="application/json")
public org.springframework.http.ResponseEntity<DTOIdentifier<Long>> post(@Valid @RequestBody
 @Valid DTOForecastGroupingConstraintInsert dto)
                                                                  throws DAValidateException,
DAException

Creates a new BOForecastGroupingConstraint object by calling the ForecastGroupingConstraintInsertEvent event

Parameters:

dto - the DTOForecastGroupingConstraintInsert object

Returns:

the response containing the ID of the newly created BOForecastGroupingConstraint

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patch

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

Updates the required BOForecastGroupingConstraint object by calling the ForecastGroupingConstraintUpdateEvent event

Parameters:

id - the id of the BOForecastGroupingConstraint object to be updated

dto - the DTOForecastGroupingConstraintUpdate object

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

delete

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

Disable the required BOForecastGroupingConstraint object by calling the ForecastGroupingConstraintDisableEvent event

Parameters:

id - the id of the BOForecastGroupingConstraint object to disable

Returns:

the DTO response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception