Package overit.geocallapp.wfm.accounts.rs1.meteraccessibility

Class MeterAccessibilityService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.accounts.rs1.meteraccessibility.MeterAccessibilityService

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

Service to manage meter accessibility

Since:

16.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
MeterAccessibilityService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOMeterAccessibility>	get(Long meterAccessibilityId, Collection<String> fields)	Retrieves the required DTOMeterAccessibility by calling the MeterAccessibilityLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOMeterAccessibility>>	getCollection(@Valid Page page, Collection<String> fields, String order, @Valid DTOMeterAccessibilityFilter filter)	Returns the collection of all the stored meter accessibilities by calling the MeterAccessibilitySearchEvent.
org.springframework.http.ResponseEntity<Void>	patch(Long id, @Valid DTOMeterAccessibilityUpdate dto)	Update a meter accessibility by calling the MeterAccessibilityUpdateEvent
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(@Valid DTOMeterAccessibilityInsert dto)	Create a new meter accessibility by calling the MeterAccessibilityInsertEvent

Methods inherited from class java.lang.Object

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

Constructor Details

MeterAccessibilityService

public MeterAccessibilityService()

Method Details

getCollection

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

Returns the collection of all the stored meter accessibilities by calling the MeterAccessibilitySearchEvent.

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 DTOMeterAccessibilityFilter

Returns:

the collection of DTOMeterAccessibility

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required DTOMeterAccessibility by calling the MeterAccessibilityLoadEvent.

Parameters:

meterAccessibilityId - the meter accessibility id

fields - the collection of fields the response will contain

Returns:

the response containing the loaded meter accessibility

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

Create a new meter accessibility by calling the MeterAccessibilityInsertEvent

Parameters:

dto - the DTOMeterAccessibilityInsert

Returns:

the standard response containing the new meter accessibility id

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patch

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

Update a meter accessibility by calling the MeterAccessibilityUpdateEvent

Parameters:

id - the meter accessibility id

dto - the DTOMeterAccessibilityUpdate

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception