Package overit.geocallapp.wfm.core.rs5.technicalobject.meter.reading.encodednote

Class EncodedNoteService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.core.rs5.technicalobject.meter.reading.encodednote.EncodedNoteService

@RestController("EncodedNoteService-legacy")
@RequestMapping("core/r5/customers/meters/readings/encodednotes")
@Resource(logging=true)
public class EncodedNoteService
extends PrivateService

Services to manage encoded notes.

Since:

19.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
EncodedNoteService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOEncodedNote>	get(Long id)	Retrieves the required encoded note.
org.springframework.http.ResponseEntity<PageResponse<DTOEncodedNote>>	getCollection(@NotNull @Valid Page page, @Valid @NotNull DTOEncodedNoteSearchFilter filter)	Retrieve the all stored encoded notes.
org.springframework.http.ResponseEntity<Void>	patch(Long id, @Valid DTOEncodedNoteUpdate input)	Modifies the required encoded note.
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(@Valid DTOEncodedNoteInsert input)	Create a new encoded note.

Methods inherited from class java.lang.Object

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

Constructor Details

EncodedNoteService

public EncodedNoteService()

Method Details

getCollection

@GetMapping(produces="application/json")
public org.springframework.http.ResponseEntity<PageResponse<DTOEncodedNote>> getCollection(@RequestParam("page") @NotNull @Valid
 @NotNull @Valid Page page,
 @RequestParam("filter") @Valid @NotNull
 @Valid @NotNull DTOEncodedNoteSearchFilter filter)
                                                                                    throws DAValidateException,
DAException

Retrieve the all stored encoded notes. EncodedNoteSearchEvent

Parameters:

page - the required result page

filter - the specified DTOEncodedNoteSearchFilter

Returns:

the response containing the current result page

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

@GetMapping(value="{id:[0-9]+}",
            produces="application/json")
public org.springframework.http.ResponseEntity<DTOEncodedNote> get(@PathVariable("id")
 Long id)
                                                            throws DAValidateException,
DAException

Retrieves the required encoded note. EncodedNoteLoadEvent

Parameters:

id - encoded note id

Returns:

the response containing the required encoded note

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 DTOEncodedNoteInsert input)
                                                                  throws DAValidateException,
DAException

Create a new encoded note. EncodedNoteInsertEvent

Parameters:

input - the DTOEncodedNote

Returns:

a standard response containing the new encoded note id

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patch

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

Modifies the required encoded note. EncodedNoteUpdateEvent

Parameters:

id - the encoded note id

input - the encoded note update DTOEncodedNote

Returns:

a standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception