Package overit.geocallapp.wfm.execution.rs1.outcomereason.encodednote

Class OutcomeReasonEncodedNoteService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.execution.rs1.outcomereason.encodednote.OutcomeReasonEncodedNoteService

@RestController
@RequestMapping("work-orders/execution/r1/outcome-reasons/{outcomeReasonId:[0-9]+}/encoded-notes")
@Resource(logging=true)
public class OutcomeReasonEncodedNoteService
extends PrivateService

Service for manage outcome reason encoded note

Since:

18.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
OutcomeReasonEncodedNoteService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	delete(Long outcomeReasonId, Long encodedNoteId)	Remove relation from outcome reason and encoded note by calling the OutcomeReasonEncodedNoteDeleteEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOOutcomeReasonEncodedNote>>	getCollection(Long outcomeReasonId, @Valid Page page, Collection<String> fields, String order, @Valid @NotNull DTOOutcomeReasonEncodedNoteFilter filter)	Retrieve the all stored relations from outcome reason and encoded note OutcomeReasonEncodedNoteSearchEvent
org.springframework.http.ResponseEntity<Void>	post(Long outcomeReasonId, @Valid DTOOutcomeReasonEncodedNoteInsert dto)	Create a new relation from outcome reason and encoded note calling the OutcomeReasonEncodedNoteInsertEvent

Methods inherited from class java.lang.Object

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

Constructor Details

OutcomeReasonEncodedNoteService

public OutcomeReasonEncodedNoteService()

Method Details

getCollection

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

Retrieve the all stored relations from outcome reason and encoded note OutcomeReasonEncodedNoteSearchEvent

Parameters:

outcomeReasonId - the outcome reason id

page - the required result page

fields - the collection of fields the response will contain

order - the ordering field

filter - the DTOOutcomeReasonEncodedNoteFilter

Returns:

the collection of DTOOutcomeReasonEncodedNote

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

post

@PostMapping(consumes="application/json",
             produces="application/json")
public org.springframework.http.ResponseEntity<Void> post(@PathVariable("outcomeReasonId")
 Long outcomeReasonId,
 @Valid @RequestBody
 @Valid DTOOutcomeReasonEncodedNoteInsert dto)
                                                   throws DAValidateException,
DAException

Create a new relation from outcome reason and encoded note calling the OutcomeReasonEncodedNoteInsertEvent

Parameters:

outcomeReasonId - the outcome reason id

dto - the DTOOutcomeReasonEncodedNoteInsert

Returns:

the empty response entity

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

delete

@DeleteMapping(value="{encodedNoteId:[0-9]+}",
               produces="application/json")
public org.springframework.http.ResponseEntity<Void> delete(@PathVariable("outcomeReasonId")
 Long outcomeReasonId,
 @PathVariable("encodedNoteId")
 Long encodedNoteId)
                                                     throws DAValidateException,
DAException

Remove relation from outcome reason and encoded note by calling the OutcomeReasonEncodedNoteDeleteEvent.

Parameters:

outcomeReasonId - the outcome reason id

encodedNoteId - the encoded note id

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception