Package overit.geocallapp.wfm.accounts.rs1.meterbrand

Class MeterBrandService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.accounts.rs1.meterbrand.MeterBrandService

@RestController
@RequestMapping("assets/accounts/r1/meter-brands")
@Resource(logging=true)
public class MeterBrandService
extends PrivateService

Service to manage meter brand

Since:

16.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
MeterBrandService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOMeterBrand>	get(Long meterBrandId, Collection<String> fields)	Retrieves the required DTOMeterBrand by calling the MeterBrandLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOMeterBrand>>	getCollection(@Valid Page page, Collection<String> fields, String order, @Valid DTOMeterBrandFilter filter)	Returns the collection of all the stored meter brands by calling the MeterBrandSearchEvent.
org.springframework.http.ResponseEntity<Void>	patch(Long meterBrandId, @Valid DTOMeterBrandUpdate dto)	Update a meter brand by calling the MeterBrandUpdateEvent
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(@Valid DTOMeterBrandInsert dto)	Create a new meter brand by calling the MeterBrandInsertEvent

Methods inherited from class java.lang.Object

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

Constructor Details

MeterBrandService

public MeterBrandService()

Method Details

getCollection

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

Returns the collection of all the stored meter brands by calling the MeterBrandSearchEvent.

Parameters:

page - the Page that will contain the paginated result

fields - the collection of fields the response will contain

order - the ordering field

filter - the DTOMeterBrandFilter

Returns:

the collection of DTOMeterBrand

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required DTOMeterBrand by calling the MeterBrandLoadEvent.

Parameters:

meterBrandId - the meter brand id

fields - the collection of fields the response will contain

Returns:

the response containing the loaded meter brand

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

Create a new meter brand by calling the MeterBrandInsertEvent

Parameters:

dto - the DTOMeterBrandInsert

Returns:

the standard response containing the new meter brand id

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patch

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

Update a meter brand by calling the MeterBrandUpdateEvent

Parameters:

meterBrandId - the meter brand id

dto - the DTOMeterBrandUpdate

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception