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

Class WorkloadDistributionRuleService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.roughplanning.rs1.weight.rule.WorkloadDistributionRuleService

@RestController
@RequestMapping("planning/workload-analysis/r1/workload-distribution-rules")
@Resource(logging=true)
public class WorkloadDistributionRuleService
extends PrivateService

Service for manage work load distribution rule

Since:

19.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
WorkloadDistributionRuleService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOWorkloadDistributionRule>	get(Long workLoadDistributionRuleId, String language, Collection<String> fields)	Retrieves the required DTOWorkloadDistributionRule by calling the WorkloadDistributionRuleLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOWorkloadDistributionRule>>	getCollection(@Valid Page page, Collection<String> fields, String order, String language, @Valid @NotNull DTOWorkloadDistributionRuleFilter filter)	Returns the collection of all the stored DTOWorkloadDistributionRule by calling the WorkloadDistributionRuleSearchEvent.
org.springframework.http.ResponseEntity<Void>	patch(Long workLoadDistributionRuleId, @Valid DTOWorkloadDistributionRuleUpdate dto)	Update a workload rule by calling the WorkloadDistributionRuleUpdateEvent
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(@Valid DTOWorkloadDistributionRuleInsert dto)	Create a new workload rule by calling the WorkloadDistributionRuleInsertEvent

Methods inherited from class java.lang.Object

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

Constructor Details

WorkloadDistributionRuleService

public WorkloadDistributionRuleService()

Method Details

getCollection

@GetMapping(produces="application/json")
public org.springframework.http.ResponseEntity<PageResponse<DTOWorkloadDistributionRule>> getCollection(@RequestParam("_page") @Valid
 @Valid Page page,
 @RequestParam(required=false,name="_fields")
 Collection<String> fields,
 @RequestParam(required=false,name="_order")
 String order,
 @RequestParam(required=false,name="_language",defaultValue="user")
 String language,
 @Valid @NotNull
 @Valid @NotNull DTOWorkloadDistributionRuleFilter filter)
                                                                                                 throws DAValidateException,
DAException

Returns the collection of all the stored DTOWorkloadDistributionRule by calling the WorkloadDistributionRuleSearchEvent.

Parameters:

page - the Page that will contain the paginated result

fields - the collection of fields the response will contain

order - the ordering field

language - the user language

filter - the DTOWorkloadDistributionRuleFilter

Returns:

the collection of DTOWorkloadDistributionRule

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required DTOWorkloadDistributionRule by calling the WorkloadDistributionRuleLoadEvent.

Parameters:

workLoadDistributionRuleId - the workLoad rule id

language - the user language

fields - the collection of fields the response will contain

Returns:

the response containing the loaded workLoad rule

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

Create a new workload rule by calling the WorkloadDistributionRuleInsertEvent

Parameters:

dto - the DTOWorkloadDistributionRuleInsert

Returns:

the standard response containing the new workload rule id

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patch

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

Update a workload rule by calling the WorkloadDistributionRuleUpdateEvent

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