Package overit.geocallapp.wfm.roughplanning.rs1.resource

Class WorkloadAnalysisResourceService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.roughplanning.rs1.resource.WorkloadAnalysisResourceService

@RestController
@RequestMapping("planning/workload-analysis/r1/workload-analyses/{workloadAnalysisId:[0-9]+}/resources")
@Resource(logging=true)
public class WorkloadAnalysisResourceService
extends PrivateService

Services to manage a BORoughPlanningResource object.

Since:

18.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
WorkloadAnalysisResourceService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	cancel(Long roughPlanningId, Long id)	Physically cancels the required BORoughPlanningResource object by calling the RoughPlanningResourceCancelEvent event
org.springframework.http.ResponseEntity<DTORoughPlanningResource>	get(Long roughPlanningId, Long roughPlanningResourceId, Collection<String> fields)	Retrieves the required BORoughPlanningResource object by calling the RoughPlanningResourceLoadEvent event
org.springframework.http.ResponseEntity<PageResponse<DTORoughPlanningResource>>	getCollection(Long roughPlanningId, @Valid Page page, Collection<String> fields, String order, @Valid DTORoughPlanningResourceSearchFilter filter)	Returns the collection of all the stored BORoughPlanningResource objects by calling the RoughPlanningResourceSearchEvent event
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(Long roughPlanningId, @Valid DTORoughPlanningResourceInsert dto)	Create a new BORoughPlanningResource object by calling the RoughPlanningResourceInsertEvent event

Methods inherited from class java.lang.Object

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

Constructor Details

WorkloadAnalysisResourceService

public WorkloadAnalysisResourceService()

Method Details

get

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

Retrieves the required BORoughPlanningResource object by calling the RoughPlanningResourceLoadEvent event

Parameters:

roughPlanningResourceId - of the rough planning resource

fields - the collection of fields the response will contain

Returns:

the response containing the loaded DTORoughPlanningResource

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

getCollection

@GetMapping(produces="application/json")
public org.springframework.http.ResponseEntity<PageResponse<DTORoughPlanningResource>> getCollection(@PathVariable("workloadAnalysisId")
 Long roughPlanningId,
 @RequestParam("_page") @Valid
 @Valid Page page,
 @RequestParam(required=false,name="_fields")
 Collection<String> fields,
 @RequestParam(required=false,name="_order")
 String order,
 @Valid
 @Valid DTORoughPlanningResourceSearchFilter filter)
                                                                                              throws DAValidateException,
DAException

Returns the collection of all the stored BORoughPlanningResource objects by calling the RoughPlanningResourceSearchEvent event

Parameters:

filter - DTORoughPlanningResourceSearchFilter object

Returns:

the response object containing the collection of DTORoughPlanningResource objects

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(@PathVariable("workloadAnalysisId")
 Long roughPlanningId,
 @Valid @RequestBody
 @Valid DTORoughPlanningResourceInsert dto)
                                                                  throws DAValidateException,
DAException

Create a new BORoughPlanningResource object by calling the RoughPlanningResourceInsertEvent event

Parameters:

dto - DTORoughPlanningResourceInsert object

Returns:

the response object containing the id of the newly created BORoughPlanningResource object

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

cancel

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

Physically cancels the required BORoughPlanningResource object by calling the RoughPlanningResourceCancelEvent event

Parameters:

id - of rough planning resource object to be physically cancelled

Returns:

the response object

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception