Package overit.geocallapp.wfm.execution.rs1.interventionresource

Class InterventionResourceService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.execution.rs1.interventionresource.InterventionResourceService

@RestController
@RequestMapping("work-orders/execution/r1/interventions/resources-accounted-hours")
@Resource(logging=true)
public class InterventionResourceService
extends PrivateService

Service to manage intervention resources.

Since:

18.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
InterventionResourceService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	delete(Long intervention, Long resource, Long workingHourType)	Delete a intervention resource, by calling the InterventionResourceDeleteEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOInterventionResource>>	getCollection(@Valid Page page, String order, Collection<String> fields, @Valid DTOInterventionResourceFilter filter)	Returns the collection of all the stored intervention resources by calling the InterventionResourceSearchEvent.
org.springframework.http.ResponseEntity<Void>	patch(Long intervention, Long resource, Long workingHourType, @Valid DTOInterventionResourceUpdate dto)	Update a intervention resource by calling the InterventionResourceUpdateEvent
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(@Valid DTOInterventionResourceInsert dto)	Inserts new accounted hours for the resource by calling the InterventionResourceInsertEvent.
org.springframework.http.ResponseEntity<Void>	validation(@Valid DTOInterventionResourceValidate dto)	Validate an intervention resource by calling the InterventionResourceValidateEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

InterventionResourceService

public InterventionResourceService()

Method Details

getCollection

@GetMapping(produces="application/json")
public org.springframework.http.ResponseEntity<PageResponse<DTOInterventionResource>> getCollection(@RequestParam("_page") @Valid
 @Valid Page page,
 @RequestParam(required=false,value="_order")
 String order,
 @RequestParam(required=false,value="_fields")
 Collection<String> fields,
 @Valid
 @Valid DTOInterventionResourceFilter filter)
                                                                                             throws DAValidateException,
DAException

Returns the collection of all the stored intervention resources by calling the InterventionResourceSearchEvent.

Parameters:

page - the page that will contain the paginated result

order - the ordering field

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

filter - the DTOInterventionResourceFilter

Returns:

the collection of DTOInterventionResources

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception is thrown

post

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

Inserts new accounted hours for the resource by calling the InterventionResourceInsertEvent.

Parameters:

dto - the DTOInterventionResourceInsert

Returns:

the response containing the ID of the newly created resource accounted hours

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

delete

@DeleteMapping(produces="application/json")
public org.springframework.http.ResponseEntity<Void> delete(@RequestParam(name="interventionId")
 Long intervention,
 @RequestParam(name="resourceId")
 Long resource,
 @RequestParam(name="workingHourTypeId")
 Long workingHourType)
                                                     throws DAValidateException,
DAException

Delete a intervention resource, by calling the InterventionResourceDeleteEvent.

Parameters:

intervention - the intervention id

resource - the resource id

workingHourType - the working hour type id

Returns:

the empty response entity

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patch

@PatchMapping(consumes="application/json",
              produces="application/json")
public org.springframework.http.ResponseEntity<Void> patch(@RequestParam(name="interventionId")
 Long intervention,
 @RequestParam(name="resourceId")
 Long resource,
 @RequestParam(name="workingHourTypeId")
 Long workingHourType,
 @Valid @RequestBody
 @Valid DTOInterventionResourceUpdate dto)
                                                    throws DAValidateException,
DAException

Update a intervention resource by calling the InterventionResourceUpdateEvent

Parameters:

intervention - the intervention id

resource - the resource id

workingHourType - the working hour type id

dto - the DTOInterventionResourceUpdate

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

validation

@PostMapping(path="validations",
             consumes="application/json",
             produces="application/json")
public org.springframework.http.ResponseEntity<Void> validation(@Valid @RequestBody
 @Valid DTOInterventionResourceValidate dto)
                                                         throws DAValidateException,
DAException

Validate an intervention resource by calling the InterventionResourceValidateEvent.

Parameters:

dto - the DTOInterventionResourceInsert

Returns:

the response containing the ID of the newly created resource accounted hours

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception