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

Class OutcomeReasonService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.execution.rs1.outcomereason.OutcomeReasonService

@RestController
@RequestMapping("work-orders/execution/r1/outcome-reasons")
@Resource(logging=true)
public class OutcomeReasonService
extends PrivateService

Service for manage outcome reason.

Since:

18.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
OutcomeReasonService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOOutcomeReason>	get(Long outcomeReasonId, String language, Collection<String> fields)	Retrieves the required DTOOutcomeReason by calling from the OutcomeReasonLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOOutcomeReason>>	getCollection(@Valid Page page, Collection<String> fields, String order, String language, @Valid @NotNull DTOOutcomeReasonFilter filter)	Returns the collection of all the stored outcome reasons by calling the OutcomeReasonSearchEvent.
org.springframework.http.ResponseEntity<Void>	patch(Long outcomeReasonId, @Valid DTOOutcomeReasonUpdate dto)	Updates the required outcome by calling the OutcomeReasonLoadEvent.
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(@Valid DTOOutcomeReasonInsert dto)	Creates a new work shift exception by calling the OutcomeReasonInsertEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

OutcomeReasonService

public OutcomeReasonService()

Method Details

getCollection

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

Returns the collection of all the stored outcome reasons by calling the OutcomeReasonSearchEvent.

Parameters:

page - the Page that will contain the paginated result

fields - the fields

order - the order field

language - the language

filter - the DTOOutcomeReasonFilter

Returns:

the collection of DTOOutcomeReason

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required DTOOutcomeReason by calling from the OutcomeReasonLoadEvent.

Parameters:

outcomeReasonId - the outcome reason id

language - the language

fields - the fields

Returns:

the response containing the loaded outcome reason

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

Creates a new work shift exception by calling the OutcomeReasonInsertEvent.

Parameters:

dto - the DTOOutcomeReasonInsert

Returns:

the response containing the ID of the newly created outcome reason

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patch

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

Updates the required outcome by calling the OutcomeReasonLoadEvent.

Parameters:

outcomeReasonId - the ID of the outcome reason to be updated

dto - the DTOOutcomeReasonUpdate

Returns:

the standard empty response

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception is thrown