Package overit.geocallapp.wfm.accounts.rs1.meter

Class MeterService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.accounts.rs1.meter.MeterService

@RestController
@RequestMapping("assets/accounts/r1/meters")
@Resource(logging=true)
public class MeterService
extends PrivateService

Service to manage meter

Since:

16.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
MeterService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOMeter>	get(Long meterId, Collection<String> fields)	Retrieves the required DTOMeter by calling the MeterLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOMeter>>	getCollection(@Valid Page page, Collection<String> fields, String order, @Valid DTOMeterFilter filter)	Returns the collection of all the stored meters by calling the MeterSearchEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

MeterService

public MeterService()

Method Details

getCollection

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

Returns the collection of all the stored meters by calling the MeterSearchEvent.

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 DTOMeterFilter

Returns:

the collection of DTOMeter

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required DTOMeter by calling the MeterLoadEvent.

Parameters:

meterId - the meter id

fields - the collection of fields the response will contain

Returns:

the response containing the loaded meter

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception