Package overit.geocallapp.wfm.orchestrator.workorders.rs1.interventionmeasure

Class OrchestratorInterventionMeasureService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.orchestrator.workorders.rs1.interventionmeasure.OrchestratorInterventionMeasureService

@RestController
@RequestMapping("work-orders/execution/r1/interventions/{interventionId:[0-9]+}/measures")
@Resource(logging=true)
public class OrchestratorInterventionMeasureService
extends PrivateService

Service to manage measures associated to interventions.

Since:

20.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
OrchestratorInterventionMeasureService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	createLinkMeasureIntervention(Long interventionId, @Valid DTOInterventionMeasureLink interventionMeasureLink)	Associates a measure to an intervention by calling the InterventionMeasureLinkEvent.
org.springframework.http.ResponseEntity<DTOInterventionMeasure>	get(Long interventionId, Long measureId, Collection<String> fields)	Retrieves a specific measure for an intervention by calling the MeasureLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOInterventionMeasure>>	getCollection(Long interventionId, @Valid Page page, Collection<String> fields, String order, @Valid @NotNull DTOInterventionMeasureFilter filter)	Retrieves a paginated collection of measures for a specific intervention by calling the MeasureSearchEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

OrchestratorInterventionMeasureService

public OrchestratorInterventionMeasureService()

Method Details

getCollection

@GetMapping(produces="application/json")
public org.springframework.http.ResponseEntity<PageResponse<DTOInterventionMeasure>> getCollection(@PathVariable("interventionId")
 Long interventionId,
 @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 DTOInterventionMeasureFilter filter)
                                                                                            throws DAValidateException,
DAException

Retrieves a paginated collection of measures for a specific intervention by calling the MeasureSearchEvent.

Parameters:

interventionId - the intervention id

page - pagination parameters

fields - optional collection of fields to include in the response

order - optional ordering specification

filter - required filter criteria for the measures

Returns:

a ResponseEntity containing a paginated list of measures

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves a specific measure for an intervention by calling the MeasureLoadEvent.

Parameters:

interventionId - the intervention id

measureId - the measure id

fields - optional collection of fields to include in the response

Returns:

a ResponseEntity containing the requested measure

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

createLinkMeasureIntervention

@PostMapping(consumes="application/json",
             produces="application/json")
public org.springframework.http.ResponseEntity<Void> createLinkMeasureIntervention(@PathVariable("interventionId")
 Long interventionId,
 @Valid @RequestBody
 @Valid DTOInterventionMeasureLink interventionMeasureLink)
                                                                            throws DAValidateException,
DAException

Associates a measure to an intervention by calling the InterventionMeasureLinkEvent.

Parameters:

interventionId - the intervention id

Returns:

the default no content ResponseEntity

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception