Package overit.geocallapp.wfm.forecastcapacity.rs1.capacityplanning.scenario

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

Constructor	Description
CapacityPlanningScenarioService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	delete(Long scenarioId)	Logically cancels the required BOCapacityPlanningScenario object by calling the CapacityPlanningScenarioCancelEvent event
org.springframework.http.ResponseEntity<DTOCapacityPlanningScenario>	get(Long scenarioId, Collection<String> fields)	Retrieves the required BOCapacityPlanningScenario object by calling the CapacityPlanningScenarioLoadEvent event
org.springframework.http.ResponseEntity<List<DTOCapacityPlanningScenarioCoverageActivityReport>>	get(Long scenarioId, Collection<String> fields, @Valid DTOCapacityPlanningScenarioCoverageActivityReportFilter filter)	Retrieves the required coverage scenario activity report
org.springframework.http.ResponseEntity<List<DTOCapacityPlanningScenarioCoverageResourceReport>>	get(Long scenarioId, Collection<String> fields, @Valid DTOCapacityPlanningScenarioCoverageResourceReportFilter filter)	Retrieves the required coverage scenario resource report
org.springframework.http.ResponseEntity<List<DTOCapacityPlanningScenarioCoverageTimeReport>>	get(Long scenarioId, Collection<String> fields, @Valid DTOCapacityPlanningScenarioCoverageTimeReportFilter filter)	Retrieves the required BOCapacityPlanningScenario object by calling the CapacityPlanningScenarioLoadEvent event
org.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 details
org.springframework.http.ResponseEntity<PageResponse<DTOCapacityPlanningScenario>>	getCollection(@Valid Page page, String order, Collection<String> fields, @Valid DTOCapacityPlanningScenarioSearchFilter filter)	Returns the collection of all the stored BOCapacityPlanningScenario objects by calling the CapacityPlanningScenarioSearchEvent event
org.springframework.http.ResponseEntity<Void>	patch(Long id, @Valid DTOCapacityPlanningScenarioUpdate dto)	Updates the required BOCapacityPlanningScenario object by calling the CapacityPlanningScenarioUpdateEvent event
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(@Valid DTOCapacityPlanningScenarioInsert dto)	Create a new BOCapacityPlanningScenario object by calling the CapacityPlanningScenarioInsertEvent event

Methods inherited from class java.lang.Object

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

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 stored BOCapacityPlanningScenario objects by calling the CapacityPlanningScenarioSearchEvent event

Parameters:

filter - the DTOActivityForecastHeaderSearchFilter object

Returns:

the collection of DTOActivityForecastHeaders

Throws:

DAValidateException - the DA validate exception

DAException - 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 required BOCapacityPlanningScenario object by calling the CapacityPlanningScenarioLoadEvent event

Parameters:

scenarioId - of the capacity planning scenario header

Returns:

the response containing the loaded DTOCapacityPlanningScenario

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

Create a new BOCapacityPlanningScenario object by calling the CapacityPlanningScenarioInsertEvent event

Parameters:

dto - the DTOCapacityPlanningScenarioInsert object

Returns:

the response containing the ID of the newly created BOCapacityPlanningScenario

Throws:

DAValidateException - the DA validate exception

DAException - 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 required BOCapacityPlanningScenario object by calling the CapacityPlanningScenarioUpdateEvent event

Parameters:

id - the of the BOCapacityPlanningScenario object to be updated

dto - the DTOCapacityPlanningScenarioUpdate object

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - 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 required BOCapacityPlanningScenario object by calling the CapacityPlanningScenarioCancelEvent event

Parameters:

scenarioId - the id of BOCapacityPlanningScenario object to be logically cancelled

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - 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 required BOCapacityPlanningScenario object by calling the CapacityPlanningScenarioLoadEvent event

Parameters:

scenarioId - of the capacity planning scenario header

Returns:

the response containing the loaded DTOCapacityPlanningScenarioCoverageTimeReport

Throws:

DAValidateException - the DA validate exception

DAException - 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 exception

DAException - 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 exception

DAException - 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 exception

DAException - the DA exception