Package overit.geocallapp.wfm.core.rs5.schedule.intervention.outcome.encodednote

Class WorkOrderEncodedNoteService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.core.rs5.schedule.intervention.outcome.encodednote.WorkOrderEncodedNoteService

@RestController
@RequestMapping("core/r5/planning/agendas/outcome/workorderencodednotes")
@Resource(logging=true)
public class WorkOrderEncodedNoteService
extends PrivateService

Services to manage work order encoded notes.

Since:

19.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
WorkOrderEncodedNoteService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOWorkOrderEncodedNote>	get(Long id, String language)	Retrieves the required encoded note.
org.springframework.http.ResponseEntity<PageResponse<DTOWorkOrderEncodedNote>>	getCollection(@NotNull @Valid Page page, @Valid @NotNull DTOWorkOrderEncodedNoteSearchFilter filter)	Retrieve the all stored encoded notes.
org.springframework.http.ResponseEntity<Void>	patch(Long id, @Valid DTOWorkOrderEncodedNoteUpdate dto)	Modifies the required encoded note.
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(@Valid DTOWorkOrderEncodedNoteInsert dto)	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

WorkOrderEncodedNoteService

public WorkOrderEncodedNoteService()

Method Details

getCollection

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

Retrieve the all stored encoded notes. WorkOrderEncodedNoteSearchEvent

Parameters:

page - the required result page

filter - the specified DTOWorkOrderEncodedNoteSearchFilter

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<DTOWorkOrderEncodedNote> get(@PathVariable("id")
 Long id,
 @RequestParam(required=false,name="language",defaultValue="user")
 String language)
                                                                     throws DAValidateException,
DAException

Retrieves the required encoded note. WorkOrderEncodedNoteLoadEvent

Parameters:

id - encoded note id

language - the language filter

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

Create a new encoded note. WorkOrderEncodedNoteInsertEvent

Parameters:

dto - the DTOWorkOrderEncodedNoteInsert

Returns:

the standard response containing the new workorder 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 DTOWorkOrderEncodedNoteUpdate dto)
                                                    throws DAValidateException,
DAException

Modifies the required encoded note. WorkOrderEncodedNoteUpdateEvent

Parameters:

id - the encoded note id

dto - the encoded note update DTOWorkOrderEncodedNoteUpdate

Returns:

a standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception