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

Class AccountMeterService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.accounts.rs1.meter.AccountMeterService

@RestController
@RequestMapping("assets/accounts/r1/accounts/{accountId}/meters")
@Resource(logging=true)
public class AccountMeterService
extends PrivateService

Service to manage meters of an account

Since:

16.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
AccountMeterService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	batchPatch(Long accountId, @Size(min=1,max=200) @Valid List<DTOMeterBatchUpdate> batchInput)	Update a batch of account meters by calling the MeterUpdateBatchEvent
org.springframework.http.ResponseEntity<List<DTOIdentifier<Long>>>	batchPost(Long accountId, @Size(min=1,max=200) @Valid List<DTOMeterBatchInsert> batchInput)	Create a batch of account meters by calling the MeterInsertBatchEvent
org.springframework.http.ResponseEntity<DTOMeter>	get(Long accountId, Long meterId, Collection<String> fields)	Retrieves the required DTOMeter by calling the MeterLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOMeter>>	getCollection(Long accountId, @Valid Page page, Collection<String> fields, String order, @Valid DTOMeterFilter filter)	Returns the collection of all the stored meters by calling the MeterSearchEvent.
org.springframework.http.ResponseEntity<DTOMeterConverter>	getConverter(Long accountId, Long meterId, Collection<String> fields)	Retrieves the required DTOMeterConverter by calling the MeterConverterLoadEvent.
org.springframework.http.ResponseEntity<Void>	patch(Long accountId, Long meterId, @Valid DTOMeterUpdate dto)	Update a meter by calling the MeterUpdateEvent
org.springframework.http.ResponseEntity<Void>	patchConverter(Long accountId, Long meterId, @Valid DTOMeterConverterUpdate dto)	Update a meter converter by calling the MeterConverterUpdateEvent
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(Long accountId, @Valid DTOMeterInsert dto)	Create a new meter by calling the MeterInsertEvent.
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	postConverter(Long accountId, Long meterId, @Valid DTOMeterConverterInsert dto)	Create a new meter converter by calling the MeterConverterInsertEvent

Methods inherited from class java.lang.Object

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

Constructor Details

AccountMeterService

public AccountMeterService()

Method Details

getCollection

@GetMapping(produces="application/json")
public org.springframework.http.ResponseEntity<PageResponse<DTOMeter>> getCollection(@PathVariable("accountId")
 Long accountId,
 @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:

accountId - the account id

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("accountId")
 Long accountId,
 @PathVariable("meterId")
 Long meterId,
 @RequestParam(required=false,name="_fields")
 Collection<String> fields)
                                                      throws DAValidateException,
DAException

Retrieves the required DTOMeter by calling the MeterLoadEvent.

Parameters:

accountId - the account id

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

post

@PostMapping(consumes="application/json",
             produces="application/json")
public org.springframework.http.ResponseEntity<DTOIdentifier<Long>> post(@PathVariable("accountId")
 Long accountId,
 @Valid @RequestBody
 @Valid DTOMeterInsert dto)
                                                                  throws DAValidateException,
DAException

Create a new meter by calling the MeterInsertEvent.

Parameters:

accountId - the account id

dto - the DTOMeterInsert

Returns:

the standard response containing the new meter id

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patch

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

Update a meter by calling the MeterUpdateEvent

Parameters:

accountId - the account id

meterId - the meter id

dto - the DTOMeterUpdate

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

getConverter

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

Retrieves the required DTOMeterConverter by calling the MeterConverterLoadEvent.

Parameters:

accountId - the account id

meterId - the meter id

fields - the collection of fields the response will contain

Returns:

the response containing the loaded meter converter

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patchConverter

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

Update a meter converter by calling the MeterConverterUpdateEvent

Parameters:

accountId - the account id

meterId - the meter id

dto - the DTOMeterConverterUpdate

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

postConverter

@PostMapping(value="{meterId:[0-9]+}/converter",
             consumes="application/json",
             produces="application/json")
public org.springframework.http.ResponseEntity<DTOIdentifier<Long>> postConverter(@PathVariable("accountId")
 Long accountId,
 @PathVariable("meterId")
 Long meterId,
 @Valid @RequestBody
 @Valid DTOMeterConverterInsert dto)
                                                                           throws DAValidateException,
DAException

Create a new meter converter by calling the MeterConverterInsertEvent

Parameters:

accountId - the account id

meterId - the meter id

dto - the DTOMeterConverterInsert

Returns:

the standard response containing the new meter converter id

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

batchPatch

@PatchMapping(value="/batch",
              consumes="application/json",
              produces="application/json")
public org.springframework.http.ResponseEntity<Void> batchPatch(@PathVariable("accountId")
 Long accountId,
 @Size(min=1,max=200) @Valid @RequestBody
 @Size(min=1,max=200) @Valid List<DTOMeterBatchUpdate> batchInput)
                                                         throws DAValidateException,
DAException

Update a batch of account meters by calling the MeterUpdateBatchEvent

Parameters:

batchInput - a list of DTOMeterBatchUpdate

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

batchPost

@PostMapping(value="/batch",
             consumes="application/json",
             produces="application/json")
public org.springframework.http.ResponseEntity<List<DTOIdentifier<Long>>> batchPost(@PathVariable("accountId")
 Long accountId,
 @Size(min=1,max=200) @Valid @RequestBody
 @Size(min=1,max=200) @Valid List<DTOMeterBatchInsert> batchInput)
                                                                             throws DAValidateException,
DAException

Create a batch of account meters by calling the MeterInsertBatchEvent

Parameters:

batchInput - a list of DTOMeterBatchInsert

Returns:

the standard response containing the list of new account meters ids

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception