Class CapacityPlanningScenarioService
java.lang.Object
overit.geocallapp.utilities.rs.common.PrivateService
overit.geocallapp.wfm.forecastcapacity.rs1.capacityplanning.scenario.CapacityPlanningScenarioService
@RestController
@RequestMapping("planning/forecast-capacity/r1/capacity-plannings/scenarios")
@Resource(logging=true)
public class CapacityPlanningScenarioService
extends PrivateService
Services to manage a
BOCapacityPlanningScenario object. - Since:
- 15.0
- GCApi:
- rest
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionorg.springframework.http.ResponseEntity<Void> Logically cancels the requiredBOCapacityPlanningScenarioobject by calling theCapacityPlanningScenarioCancelEventeventorg.springframework.http.ResponseEntity<DTOCapacityPlanningScenario> get(Long scenarioId, Collection<String> fields) Retrieves the requiredBOCapacityPlanningScenarioobject by calling theCapacityPlanningScenarioLoadEventeventorg.springframework.http.ResponseEntity<List<DTOCapacityPlanningScenarioCoverageActivityReport>> get(Long scenarioId, Collection<String> fields, @Valid DTOCapacityPlanningScenarioCoverageActivityReportFilter filter) Retrieves the required coverage scenario activity reportorg.springframework.http.ResponseEntity<List<DTOCapacityPlanningScenarioCoverageResourceReport>> get(Long scenarioId, Collection<String> fields, @Valid DTOCapacityPlanningScenarioCoverageResourceReportFilter filter) Retrieves the required coverage scenario resource reportorg.springframework.http.ResponseEntity<List<DTOCapacityPlanningScenarioCoverageTimeReport>> get(Long scenarioId, Collection<String> fields, @Valid DTOCapacityPlanningScenarioCoverageTimeReportFilter filter) Retrieves the requiredBOCapacityPlanningScenarioobject by calling theCapacityPlanningScenarioLoadEventeventorg.springframework.http.ResponseEntity<PageResponse<DTOCapacityPlanningScenarioCoverageTimeReportDetail>> get(Long scenarioId, @Valid Page page, String order, Collection<String> fields, @Valid DTOCapacityPlanningScenarioCoverageTimeReportDetailFilter filter) Retrieves the required coverage scenario time report detailsorg.springframework.http.ResponseEntity<PageResponse<DTOCapacityPlanningScenario>> getCollection(@Valid Page page, String order, Collection<String> fields, @Valid DTOCapacityPlanningScenarioSearchFilter filter) Returns the collection of all the storedBOCapacityPlanningScenarioobjects by calling theCapacityPlanningScenarioSearchEventeventorg.springframework.http.ResponseEntity<Void> patch(Long id, @Valid DTOCapacityPlanningScenarioUpdate dto) Updates the requiredBOCapacityPlanningScenarioobject by calling theCapacityPlanningScenarioUpdateEventeventorg.springframework.http.ResponseEntity<DTOIdentifier<Long>> Create a newBOCapacityPlanningScenarioobject by calling theCapacityPlanningScenarioInsertEventevent
-
Constructor Details
-
CapacityPlanningScenarioService
public CapacityPlanningScenarioService()
-
-
Method Details
-
getCollection
@GetMapping(produces="application/json") public org.springframework.http.ResponseEntity<PageResponse<DTOCapacityPlanningScenario>> getCollection(@RequestParam("_page") @Valid @Valid Page page, @RequestParam(required=false,value="_order") String order, @RequestParam(required=false,value="_fields") Collection<String> fields, @Valid @Valid DTOCapacityPlanningScenarioSearchFilter filter) throws DAValidateException, DAException Returns the collection of all the storedBOCapacityPlanningScenarioobjects by calling theCapacityPlanningScenarioSearchEventevent- Parameters:
filter- theDTOActivityForecastHeaderSearchFilterobject- Returns:
- the collection of
DTOActivityForecastHeaders - Throws:
DAValidateException- the DA validate exceptionDAException- the DA exception
-
get
@GetMapping(value="{scenarioId:[0-9]+}", produces="application/json") public org.springframework.http.ResponseEntity<DTOCapacityPlanningScenario> get(@PathVariable("scenarioId") Long scenarioId, @RequestParam(required=false,value="_fields") Collection<String> fields) throws DAValidateException, DAException Retrieves the requiredBOCapacityPlanningScenarioobject by calling theCapacityPlanningScenarioLoadEventevent- Parameters:
scenarioId- of the capacity planning scenario header- Returns:
- the response containing the loaded
DTOCapacityPlanningScenario - Throws:
DAValidateException- the DA validate exceptionDAException- the DA exception
-
post
@PostMapping(consumes="application/json", produces="application/json") public org.springframework.http.ResponseEntity<DTOIdentifier<Long>> post(@Valid @RequestBody @Valid DTOCapacityPlanningScenarioInsert dto) throws DAValidateException, DAException Create a newBOCapacityPlanningScenarioobject by calling theCapacityPlanningScenarioInsertEventevent- Parameters:
dto- theDTOCapacityPlanningScenarioInsertobject- Returns:
- the response containing the ID of the newly created
BOCapacityPlanningScenario - Throws:
DAValidateException- the DA validate exceptionDAException- the DA exception
-
patch
@PatchMapping(value="{scenarioId:[0-9]+}", consumes="application/json", produces="application/json") public org.springframework.http.ResponseEntity<Void> patch(@PathVariable("scenarioId") Long id, @Valid @RequestBody @Valid DTOCapacityPlanningScenarioUpdate dto) throws DAValidateException, DAException Updates the requiredBOCapacityPlanningScenarioobject by calling theCapacityPlanningScenarioUpdateEventevent- Parameters:
id- the of theBOCapacityPlanningScenarioobject to be updateddto- theDTOCapacityPlanningScenarioUpdateobject- Returns:
- the standard response
- Throws:
DAValidateException- the DA validate exceptionDAException- the DA exception
-
delete
@DeleteMapping(value="{scenarioId:[0-9]+}", produces="application/json") public org.springframework.http.ResponseEntity<Void> delete(@PathVariable("scenarioId") Long scenarioId) throws DAValidateException, DAException Logically cancels the requiredBOCapacityPlanningScenarioobject by calling theCapacityPlanningScenarioCancelEventevent- Parameters:
scenarioId- the id ofBOCapacityPlanningScenarioobject to be logically cancelled- Returns:
- the standard response
- Throws:
DAValidateException- the DA validate exceptionDAException- the DA exception
-
get
@GetMapping(value="{scenarioId:[0-9]+}/coverage-scenario-time-reports", produces="application/json") public org.springframework.http.ResponseEntity<List<DTOCapacityPlanningScenarioCoverageTimeReport>> get(@PathVariable("scenarioId") Long scenarioId, @RequestParam(required=false,value="_fields") Collection<String> fields, @Valid @Valid DTOCapacityPlanningScenarioCoverageTimeReportFilter filter) throws DAValidateException, DAException Retrieves the requiredBOCapacityPlanningScenarioobject by calling theCapacityPlanningScenarioLoadEventevent- Parameters:
scenarioId- of the capacity planning scenario header- Returns:
- the response containing the loaded
DTOCapacityPlanningScenarioCoverageTimeReport - Throws:
DAValidateException- the DA validate exceptionDAException- the DA exception
-
get
@GetMapping(value="{scenarioId:[0-9]+}/coverage-scenario-time-report-details", produces="application/json") public org.springframework.http.ResponseEntity<PageResponse<DTOCapacityPlanningScenarioCoverageTimeReportDetail>> get(@PathVariable("scenarioId") Long scenarioId, @RequestParam("_page") @Valid @Valid Page page, @RequestParam(required=false,value="_order") String order, @RequestParam(required=false,value="_fields") Collection<String> fields, @Valid @Valid DTOCapacityPlanningScenarioCoverageTimeReportDetailFilter filter) throws DAValidateException, DAException Retrieves the required coverage scenario time report details- Parameters:
scenarioId- of the capacity planning scenario header- Returns:
- the response containing the loaded
DTOCapacityPlanningScenario - Throws:
DAValidateException- the DA validate exceptionDAException- the DA exception
-
get
@GetMapping(value="{scenarioId:[0-9]+}/coverage-resource-reports", produces="application/json") public org.springframework.http.ResponseEntity<List<DTOCapacityPlanningScenarioCoverageResourceReport>> get(@PathVariable("scenarioId") Long scenarioId, @RequestParam(required=false,value="_fields") Collection<String> fields, @Valid @Valid DTOCapacityPlanningScenarioCoverageResourceReportFilter filter) throws DAValidateException, DAException Retrieves the required coverage scenario resource report- Parameters:
scenarioId- of the capacity planning scenario header- Returns:
- the response containing the loaded
DTOCapacityPlanningScenarioCoverageResourceReport - Throws:
DAValidateException- the DA validate exceptionDAException- the DA exception
-
get
@GetMapping(value="{scenarioId:[0-9]+}/coverage-activity-reports", produces="application/json") public org.springframework.http.ResponseEntity<List<DTOCapacityPlanningScenarioCoverageActivityReport>> get(@PathVariable("scenarioId") Long scenarioId, @RequestParam(required=false,value="_fields") Collection<String> fields, @Valid @Valid DTOCapacityPlanningScenarioCoverageActivityReportFilter filter) throws DAValidateException, DAException Retrieves the required coverage scenario activity report- Parameters:
scenarioId- of the capacity planning scenario header- Returns:
- the response containing the loaded
DTOCapacityPlanningScenarioCoverageActivityReport - Throws:
DAValidateException- the DA validate exceptionDAException- the DA exception
-