Package overit.geocallapp.wfm.accounts.rs1.meterclass

Class MeterClassService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.accounts.rs1.meterclass.MeterClassService

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

Service to manage meter class

Since:

16.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
MeterClassService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOMeterClass>	get(Long meterClassId, Collection<String> fields)	Retrieves the required DTOMeterClass by calling the MeterClassLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOMeterClass>>	getCollection(@Valid Page page, Collection<String> fields, String order, @Valid DTOMeterClassFilter filter)	Returns the collection of all the stored meter classes by calling the MeterClassSearchEvent.
org.springframework.http.ResponseEntity<Void>	patch(Long meterClassId, @Valid DTOMeterClassUpdate dto)	Update a meter class by calling the MeterClassUpdateEvent
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(@Valid DTOMeterClassInsert dto)	Create a new meter class by calling the MeterClassInsertEvent

Methods inherited from class java.lang.Object

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

Constructor Details

MeterClassService

public MeterClassService()

Method Details

getCollection

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

Returns the collection of all the stored meter classes by calling the MeterClassSearchEvent.

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 DTOMeterClassFilter

Returns:

the collection of DTOMeterClass

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required DTOMeterClass by calling the MeterClassLoadEvent.

Parameters:

meterClassId - the meter class id

fields - the collection of fields the response will contain

Returns:

the response containing the loaded meter class

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

Create a new meter class by calling the MeterClassInsertEvent

Parameters:

dto - the DTOMeterClassInsert

Returns:

the standard response containing the new meter class id

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patch

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

Update a meter class by calling the MeterClassUpdateEvent

Parameters:

meterClassId - the meter class id

dto - the DTOMeterClassUpdate

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception