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 -
Method Summary
Modifier and TypeMethodDescriptionorg.springframework.http.ResponseEntity<Void> Disable the requiredBOForecastGroupingConstraintobject by calling theForecastGroupingConstraintDisableEventeventorg.springframework.http.ResponseEntity<DTOForecastGroupingConstraint> get(Long id, Collection<String> fields) Retrieves the requiredBOForecastGroupingConstraintobject by calling theForecastGroupingConstraintLoadEventeventorg.springframework.http.ResponseEntity<PageResponse<DTOForecastGroupingConstraint>> getCollection(@Valid Page page, String order, Collection<String> fields, @Valid DTOForecastGroupingConstraintSearchFilter filter) Returns the collection of all the storedBOForecastGroupingConstraintobjects by calling theForecastGroupingConstraintSearchEventeventorg.springframework.http.ResponseEntity<Void> Updates the requiredBOForecastGroupingConstraintobject by calling theForecastGroupingConstraintUpdateEventeventorg.springframework.http.ResponseEntity<DTOIdentifier<Long>> Creates a newBOForecastGroupingConstraintobject by calling theForecastGroupingConstraintInsertEventevent
-
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 storedBOForecastGroupingConstraintobjects by calling theForecastGroupingConstraintSearchEventevent- Parameters:
page- the pageorder- the orderfields- the collection of fields that will be contained in the responsefilter- theDTOForecastGroupingConstraintSearchFilterobject- Returns:
- the collection of
DTOForecastGroupingConstraints - Throws:
DAValidateException- the DA validate exceptionDAException- 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 requiredBOForecastGroupingConstraintobject by calling theForecastGroupingConstraintLoadEventevent- Parameters:
id- theBOForecastGroupingConstraintobject's id fieldfields- 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 exceptionDAException- if a genericExceptionis 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 newBOForecastGroupingConstraintobject by calling theForecastGroupingConstraintInsertEventevent- Parameters:
dto- theDTOForecastGroupingConstraintInsertobject- Returns:
- the response containing the ID of the newly created
BOForecastGroupingConstraint - Throws:
DAValidateException- the DA validate exceptionDAException- 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 requiredBOForecastGroupingConstraintobject by calling theForecastGroupingConstraintUpdateEventevent- Parameters:
id- the id of theBOForecastGroupingConstraintobject to be updateddto- theDTOForecastGroupingConstraintUpdateobject- Returns:
- the standard response
- Throws:
DAValidateException- the DA validate exceptionDAException- 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 requiredBOForecastGroupingConstraintobject by calling theForecastGroupingConstraintDisableEventevent- Parameters:
id- the id of theBOForecastGroupingConstraintobject to disable- Returns:
- the DTO response
- Throws:
DAValidateException- the DA validate exceptionDAException- the DA exception
-