Package overit.geocallapp.wfm.core.bundler.rs2.configuration.bundling.rule

Class BundlingRuleHeaderService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.core.bundler.rs2.configuration.bundling.rule.BundlingRuleHeaderService

@RestController
@RequestMapping("bundler/r2/config/bundling/rules")
@Resource(logging=true)
public class BundlingRuleHeaderService
extends PrivateService

Service to manage Bundling Rule Header.

Since:

19.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
BundlingRuleHeaderService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOBundlingRuleHeader>	get(Long id)	Retrieves the required bundling rule header.
org.springframework.http.ResponseEntity<PageResponse<DTOBundlingRuleHeader>>	getCollection(@NotNull @Valid Page page, @Valid @NotNull DTOBundlingRuleHeaderSearchFilter filter)	Retrieves all the stored bundling rule headers.
org.springframework.http.ResponseEntity<Void>	patch(Long id, @Valid DTOBundlingRuleHeaderUpdate dto)	Modifies the required bundling rule header.
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(@Valid DTOBundlingRuleHeaderInsert dto)	Create a new bundling rule header.

Methods inherited from class java.lang.Object

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

Constructor Details

BundlingRuleHeaderService

public BundlingRuleHeaderService()

Method Details

getCollection

@GetMapping(produces="application/json")
public org.springframework.http.ResponseEntity<PageResponse<DTOBundlingRuleHeader>> getCollection(@RequestParam("page") @NotNull @Valid
 @NotNull @Valid Page page,
 @RequestParam("filter") @Valid @NotNull
 @Valid @NotNull DTOBundlingRuleHeaderSearchFilter filter)
                                                                                           throws DAValidateException,
DAException

Retrieves all the stored bundling rule headers. BundlingRuleHeaderSearchEvent

Parameters:

page - the page

filter - the DTOBundlingRuleHeaderSearchFilter

Returns:

the response containing the collection

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

@GetMapping(value="{id:[0-9]+}",
            produces="application/json")
public org.springframework.http.ResponseEntity<DTOBundlingRuleHeader> get(@PathVariable("id")
 Long id)
                                                                   throws DAValidateException,
DAException

Retrieves the required bundling rule header. BundlingRuleHeaderLoadEvent

Parameters:

id - the id

Returns:

the response containing the required DTO bundling rule header

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

Create a new bundling rule header. BundlingRuleHeaderInsertEvent

Parameters:

dto - the DTOBundlingRuleHeaderInsert

Returns:

the standard response containing the new bundling rule header id

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patch

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

Modifies the required bundling rule header. BundlingRuleHeaderUpdateEvent

Parameters:

id - the id

dto - the DTOBundlingRuleHeaderUpdate

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception