Package overit.geocallapp.wfm.roughplanning.rs1.bucket

Class WorkloadAnalysisBucketService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.roughplanning.rs1.bucket.WorkloadAnalysisBucketService

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

Services to manage a BORoughPlanningBucket object.

Since:

18.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
WorkloadAnalysisBucketService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTORoughPlanningBucket>	get(Long roughPlanningId, Long roughPlanningBucketId, Collection<String> fields)	Retrieves the required BORoughPlanningBucket object by calling the RoughPlanningBucketLoadEvent event
org.springframework.http.ResponseEntity<PageResponse<DTORoughPlanningBucket>>	getCollection(Long roughPlanningId, @Valid Page page, Collection<String> fields, String order)	Returns the collection of all the stored BORoughPlanningBucket objects by calling the RoughPlanningBucketSearchEvent event
org.springframework.http.ResponseEntity<Void>	patch(Long roughPlanningId, Long id, @Valid DTORoughPlanningBucketUpdate dto)	Updates the required BORoughPlanningBucket object by calling the RoughPlanningBucketUpdateEvent event
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(Long roughPlanningId, @Valid DTORoughPlanningBucketInsert dto)	Create a new BORoughPlanningBucket object by calling the RoughPlanningBucketInsertEvent event

Methods inherited from class java.lang.Object

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

Constructor Details

WorkloadAnalysisBucketService

public WorkloadAnalysisBucketService()

Method Details

get

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

Retrieves the required BORoughPlanningBucket object by calling the RoughPlanningBucketLoadEvent event

Parameters:

roughPlanningBucketId - of the rough planning bucket

fields - the collection of fields the response will contain

Returns:

the response containing the loaded DTORoughPlanningBucket

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

getCollection

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

Returns the collection of all the stored BORoughPlanningBucket objects by calling the RoughPlanningBucketSearchEvent event

Returns:

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

Create a new BORoughPlanningBucket object by calling the RoughPlanningBucketInsertEvent event

Parameters:

dto - DTORoughPlanningBucketInsert object

Returns:

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

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patch

@PatchMapping(value="{workloadAnalysisBucketId:[0-9]+}",
              consumes="application/json",
              produces="application/json")
public org.springframework.http.ResponseEntity<Void> patch(@PathVariable("workloadAnalysisId")
 Long roughPlanningId,
 @PathVariable("workloadAnalysisBucketId")
 Long id,
 @Valid @RequestBody
 @Valid DTORoughPlanningBucketUpdate dto)
                                                    throws DAValidateException,
DAException

Updates the required BORoughPlanningBucket object by calling the RoughPlanningBucketUpdateEvent event

Parameters:

id - of the BORoughPlanningBucket object to be updated

dto - DTORoughPlanningBucketUpdate object

Returns:

the standard object

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception