Package overit.geocallapp.wfm.execution.rs1.outcomereasontype

Class OutcomeReasonTypeService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.execution.rs1.outcomereasontype.OutcomeReasonTypeService

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

Service for manage outcome reason type.

Since:

18.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
OutcomeReasonTypeService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOOutcomeReasonType>	get(Long outcomeReasonTypeId, String language, Collection<String> fields)	Retrieves the required DTOOutcomeReasonType by calling from the OutcomeReasonTypeLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOOutcomeReasonType>>	getCollection(@Valid Page page, Collection<String> fields, String order, String language, @Valid @NotNull DTOOutcomeReasonTypeFilter filter)	Returns the collection of all the stored outcome reason types by calling the OutcomeReasonTypeSearchEvent.
org.springframework.http.ResponseEntity<Void>	patch(Long outcomeReasonTypeId, @Valid DTOOutcomeReasonTypeUpdate dto)	Updates the required work shift exception by calling the OutcomeReasonTypeLoadEvent.
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(@Valid DTOOutcomeReasonTypeInsert dto)	Creates a new outcome reason type by calling the OutcomeReasonTypeInsertEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

OutcomeReasonTypeService

public OutcomeReasonTypeService()

Method Details

getCollection

@GetMapping(produces="application/json")
public org.springframework.http.ResponseEntity<PageResponse<DTOOutcomeReasonType>> 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 DTOOutcomeReasonTypeFilter filter)
                                                                                          throws DAValidateException,
DAException

Returns the collection of all the stored outcome reason types by calling the OutcomeReasonTypeSearchEvent.

Parameters:

page - the Page that will contain the paginated result

fields - the collection of fields that will be contained in the response

order - the ordering field

language - the language

filter - the DTOOutcomeReasonTypeFilter

Returns:

the collection of DTOOutcomeReasonType

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required DTOOutcomeReasonType by calling from the OutcomeReasonTypeLoadEvent.

Parameters:

outcomeReasonTypeId - the outcome reason type id

language - the language

fields - the collection of fields that will be contained in the response

Returns:

the response containing the loaded outcome reason type

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

Creates a new outcome reason type by calling the OutcomeReasonTypeInsertEvent.

Parameters:

dto - the DTOOutcomeReasonTypeInsert

Returns:

the response containing the ID of the newly created outcome reason type

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patch

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

Updates the required work shift exception by calling the OutcomeReasonTypeLoadEvent.

Parameters:

outcomeReasonTypeId - the outcome reason type id

dto - the DTOOutcomeReasonTypeUpdate

Returns:

the standard empty response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception