Package overit.geocallapp.wfm.roughplanning.rs1.weight.workloaddistributionweight

Class WorkloadDistributionWeightService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.roughplanning.rs1.weight.workloaddistributionweight.WorkloadDistributionWeightService

@RestController
@RequestMapping("planning/workload-analysis/r1/workload-distribution-rules/{workloadDistributionRuleId:[0-9]+}/workload-distribution-weights")
@Resource(logging=true)
public class WorkloadDistributionWeightService
extends PrivateService

Service for manage workload distribution weight

Since:

19.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
WorkloadDistributionWeightService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	delete(Long workLoadDistributionRuleId, Long workloadDistributionWeightId)	Deletes the required BOWorkloadDistributionWeight object from a given BOWorkloadDistributionWeight object by calling the WorkloadRuleWOCombinationDeleteEvent event
org.springframework.http.ResponseEntity<DTOWorkloadDistributionWeight>	get(Long workLoadDistributionRuleId, Long workloadDistributionWeightId, Collection<String> fields)	Retrieves the required DTOWorkloadDistributionWeight by calling the WorkloadDistributionWeightLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOWorkloadDistributionWeight>>	getCollection(@Valid Page page, Collection<String> fields, String order, Long workLoadDistributionRuleId, @Valid @NotNull DTOWorkloadDistributionWeightFilter filter)	Returns the collection of all the stored DTOWorkloadDistributionWeight by calling the WorkloadDistributionWeightSearchEvent.
org.springframework.http.ResponseEntity<Void>	patch(Long workLoadDistributionRuleId, Long workloadDistributionWeightId, @Valid DTOWorkloadDistributionWeightUpdate dto)	Update a workload distribution weight by calling the WorkloadDistributionWeightUpdateEvent
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(Long workLoadDistributionRuleId, @Valid DTOWorkloadDistributionWeightInsert dto)	Create a new workloaf distribution weight by calling the WorkloadDistributionWeightInsertEvent

Methods inherited from class java.lang.Object

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

Constructor Details

WorkloadDistributionWeightService

public WorkloadDistributionWeightService()

Method Details

getCollection

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

Returns the collection of all the stored DTOWorkloadDistributionWeight by calling the WorkloadDistributionWeightSearchEvent.

Parameters:

page - the Page that will contain the paginated result

fields - the collection of fields the response will contain

order - the ordering field

workLoadDistributionRuleId - the workload rule id

filter - the DTOWorkloadDistributionWeightFilter

Returns:

the collection of DTOWorkloadDistributionWeight

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required DTOWorkloadDistributionWeight by calling the WorkloadDistributionWeightLoadEvent.

Parameters:

workLoadDistributionRuleId - the workload rule id

workloadDistributionWeightId - the workload weight id

fields - the collection of fields the response will contain

Returns:

the response containing the loaded workLoad Rule WO Combination

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("workloadDistributionRuleId")
 Long workLoadDistributionRuleId,
 @Valid @RequestBody
 @Valid DTOWorkloadDistributionWeightInsert dto)
                                                                  throws DAValidateException,
DAException

Create a new workloaf distribution weight by calling the WorkloadDistributionWeightInsertEvent

Parameters:

workLoadDistributionRuleId - the workload rule id

dto - the DTOWorkloadDistributionWeightInsert

Returns:

the standard response containing the new workLoad Rule WO Combination id

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patch

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

Update a workload distribution weight by calling the WorkloadDistributionWeightUpdateEvent

Parameters:

workLoadDistributionRuleId - the workload rule id

dto - the DTOWorkloadDistributionRuleUpdate values to be updated

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

delete

@DeleteMapping(value="{workloadDistributionWeightId:[0-9]+}",
               produces="application/json")
public org.springframework.http.ResponseEntity<Void> delete(@PathVariable("workloadDistributionRuleId")
 Long workLoadDistributionRuleId,
 @PathVariable("workloadDistributionWeightId")
 Long workloadDistributionWeightId)
                                                     throws DAValidateException,
DAException

Deletes the required BOWorkloadDistributionWeight object from a given BOWorkloadDistributionWeight object by calling the WorkloadRuleWOCombinationDeleteEvent event

Parameters:

workloadDistributionWeightId - the id of the BOWorkloadDistributionWeight object to delete

Returns:

the DTO response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception