Package overit.geocallapp.wfm.accounts.rs1.readingmetertype

Class ReadingMeterTypeService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.accounts.rs1.readingmetertype.ReadingMeterTypeService

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

Service to manage reading meter type.

Since:

20.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
ReadingMeterTypeService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOReadingMeterType>	get(Long id, Collection<String> fields)	Retrieves the required DTOReadingMeterType by calling the ReadingMeterTypeLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOReadingMeterType>>	getCollection(@Valid Page page, Collection<String> fields, String order, @Valid DTOReadingMeterTypeFilter filter)	Returns the collection of all the stored reading meter types by calling the ReadingMeterTypeSearchEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

ReadingMeterTypeService

public ReadingMeterTypeService()

Method Details

getCollection

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

Returns the collection of all the stored reading meter types by calling the ReadingMeterTypeSearchEvent.

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 DTOReadingMeterTypeFilter

Returns:

the collection of DTOReadingMeterType

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required DTOReadingMeterType by calling the ReadingMeterTypeLoadEvent.

Parameters:

id - the reading meter type id

fields - the collection of fields the response will contain

Returns:

the response containing the loaded reading meter type

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception