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

Class WorkloadAnalysisResourceResultService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.roughplanning.rs1.resource.result.WorkloadAnalysisResourceResultService

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

Services to manage a BORoughPlanningResourceResult object.

Since:

18.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
WorkloadAnalysisResourceResultService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTORoughPlanningResourceResult>	get(Long roughPlanningId, Long roughPlanningResourceResultId, Collection<String> fields)	Retrieves the required BORoughPlanningResourceResult object by calling the RoughPlanningResourceResultLoadEvent event
org.springframework.http.ResponseEntity<PageResponse<DTORoughPlanningResourceResult>>	getCollection(Long roughPlanningId, @Valid Page page, Collection<String> fields, String order, @Valid DTORoughPlanningResourceResultSearchFilter filter)	Returns the collection of all the stored BORoughPlanningResourceResult objects by calling the RoughPlanningResourceResultSearchEvent event
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(Long roughPlanningId, @Valid DTORoughPlanningResourceResultInsert dto)	Create a new BORoughPlanningResourceResult object by calling the RoughPlanningResourceResultInsertEvent event

Methods inherited from class java.lang.Object

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

Constructor Details

WorkloadAnalysisResourceResultService

public WorkloadAnalysisResourceResultService()

Method Details

get

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

Retrieves the required BORoughPlanningResourceResult object by calling the RoughPlanningResourceResultLoadEvent event

Parameters:

roughPlanningResourceResultId - of the rough planning resource

fields - the collection of fields the response will contain

Returns:

the response containing the loaded DTORoughPlanningResourceResult

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

getCollection

@GetMapping(produces="application/json")
public org.springframework.http.ResponseEntity<PageResponse<DTORoughPlanningResourceResult>> 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 DTORoughPlanningResourceResultSearchFilter filter)
                                                                                                    throws DAValidateException,
DAException

Returns the collection of all the stored BORoughPlanningResourceResult objects by calling the RoughPlanningResourceResultSearchEvent event

Parameters:

filter - DTORoughPlanningResourceResultSearchFilter object

Returns:

the response object containing the collection of DTORoughPlanningResourceResult 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 DTORoughPlanningResourceResultInsert dto)
                                                                  throws DAValidateException,
DAException

Create a new BORoughPlanningResourceResult object by calling the RoughPlanningResourceResultInsertEvent event

Parameters:

dto - DTORoughPlanningResourceResultInsert object

Returns:

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

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception