Package overit.geocallapp.wfm.orchestrator.assets.rs1.account.measuringelement.measure

Class OrchestratorAccountMeasuringElementMeasureService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.orchestrator.assets.rs1.account.measuringelement.measure.OrchestratorAccountMeasuringElementMeasureService

@RestController
@RequestMapping("assets/accounts/r1/accounts/{accountId:[0-9]+}/measuring-elements/{measuringElementId:[0-9]+}/measures")
@Resource(logging=true)
public class OrchestratorAccountMeasuringElementMeasureService
extends PrivateService

Service for manage measure.

Since:

20.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
OrchestratorAccountMeasuringElementMeasureService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	batchPatch(Long accountId, Long measuringElementId, @Size(min=1,max=50) @Valid List<DTOAccountMeasuringElementMeasureBatchUpdate> batchInput)	Updates multiple measures for an account's measuring element in a single batch operation.
org.springframework.http.ResponseEntity<List<DTOIdentifier<Long>>>	batchPost(@Size(min=1,max=50) @Valid List<DTOAccountMeasuringElementMeasureBatchInsert> dtos, Long accountId, Long measuringElementId)	Creates multiple measures for an account's measuring element in a single batch operation.
org.springframework.http.ResponseEntity<Void>	batchReject(Long accountId, Long measuringElementId, @Size(min=1,max=50) @Valid List<DTOAccountMeasuringElementMeasureBatchStatusChange> batchInput)	Rejects a batch of measures for a specific account's measuring element.
org.springframework.http.ResponseEntity<Void>	batchValidate(Long accountId, Long measuringElementId, @Size(min=1,max=50) @Valid List<DTOAccountMeasuringElementMeasureBatchStatusChange> batchInput)	Validates a batch of measures for a specific account's measuring element.
org.springframework.http.ResponseEntity<DTOAccountMeasuringElementMeasure>	get(Long accountId, Long measuringElementId, Long measureId, Collection<String> fields)	Retrieves a specific measure for an account's measuring element.
org.springframework.http.ResponseEntity<PageResponse<DTOAccountMeasuringElementMeasure>>	getCollection(Long accountId, Long measuringElementId, @Valid Page page, Collection<String> fields, String order, @Valid @NotNull DTOAccountMeasuringElementMeasureFilter filter)	Retrieves a paginated collection of measures for a specific account's measuring element.
org.springframework.http.ResponseEntity<Void>	patch(Long accountId, Long measuringElementId, Long measureId, @Valid DTOAccountMeasuringElementMeasureUpdate dto)	Updates an existing measure for an account's measuring element.
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(Long accountId, Long measuringElementId, @Valid DTOAccountMeasuringElementMeasureInsert dto)	Creates a new measure for an account's measuring element.
org.springframework.http.ResponseEntity<Void>	reject(Long accountId, Long measuringElementId, Long measureId)	Rejects an existing measure for an account's measuring element.
org.springframework.http.ResponseEntity<Void>	validate(Long accountId, Long measuringElementId, Long measureId)	Validates an existing measure for an account's measuring element.

Methods inherited from class java.lang.Object

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

Constructor Details

OrchestratorAccountMeasuringElementMeasureService

public OrchestratorAccountMeasuringElementMeasureService()

Method Details

getCollection

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

Retrieves a paginated collection of measures for a specific account's measuring element.

Parameters:

accountId - the account id

measuringElementId - the measuring element 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<DTOAccountMeasuringElementMeasure> get(@PathVariable("accountId")
 Long accountId,
 @PathVariable("measuringElementId")
 Long measuringElementId,
 @PathVariable("measureId")
 Long measureId,
 @RequestParam(required=false,value="_fields")
 Collection<String> fields)
                                                                               throws DAValidateException,
DAException

Retrieves a specific measure for an account's measuring element.

Parameters:

accountId - the account id

measuringElementId - the measuring element 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

post

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

Creates a new measure for an account's measuring element.

Parameters:

accountId - the account id

measuringElementId - the measuring element id

dto - the DTOAccountMeasuringElementMeasureInsert

Returns:

a ResponseEntity containing the identifier of the created measure

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patch

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

Updates an existing measure for an account's measuring element.

Parameters:

accountId - the account id

measuringElementId - the measuring element id

measureId - the measure id

dto - the DTOAccountMeasuringElementMeasureUpdate

Returns:

a ResponseEntity with no content on successful update

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

validate

@PostMapping(value="/{measureId:[0-9]+}/validations",
             produces="application/json")
public org.springframework.http.ResponseEntity<Void> validate(@PathVariable("accountId")
 Long accountId,
 @PathVariable("measuringElementId")
 Long measuringElementId,
 @PathVariable("measureId")
 Long measureId)
                                                       throws DAValidateException,
DAException

Validates an existing measure for an account's measuring element.

Parameters:

accountId - the account id

measuringElementId - the measuring element id

measureId - the measure id

Returns:

a org.springframework.http.ResponseEntity<Void> with no content on successful validation

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

reject

@PostMapping(value="/{measureId:[0-9]+}/rejections",
             produces="application/json")
public org.springframework.http.ResponseEntity<Void> reject(@PathVariable("accountId")
 Long accountId,
 @PathVariable("measuringElementId")
 Long measuringElementId,
 @PathVariable("measureId")
 Long measureId)
                                                     throws DAValidateException,
DAException

Rejects an existing measure for an account's measuring element.

Parameters:

accountId - the account id

measuringElementId - the measuring element id

measureId - the measure id

Returns:

a org.springframework.http.ResponseEntity<Void> with no content on successful rejection

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

batchPost

@PostMapping(value="/batch",
             consumes="application/json",
             produces="application/json")
public org.springframework.http.ResponseEntity<List<DTOIdentifier<Long>>> batchPost(@Size(min=1,max=50) @Valid @RequestBody
 @Size(min=1,max=50) @Valid List<DTOAccountMeasuringElementMeasureBatchInsert> dtos,
 @PathVariable("accountId")
 Long accountId,
 @PathVariable("measuringElementId")
 Long measuringElementId)
                                                                             throws DAValidateException,
DAException

Creates multiple measures for an account's measuring element in a single batch operation.

Parameters:

dtos - the list of DTOAccountMeasuringElementMeasureBatchInsert objects containing the measure data

accountId - the account id

measuringElementId - the measuring element id

Returns:

a ResponseEntity containing a list of DTOIdentifier<Long> with the IDs of the created measures

Throws:

DAValidateException - if validation fails

DAException - if a data access error occurs

batchPatch

@PatchMapping(value="/batch",
              consumes="application/json",
              produces="application/json")
public org.springframework.http.ResponseEntity<Void> batchPatch(@PathVariable("accountId")
 Long accountId,
 @PathVariable("measuringElementId")
 Long measuringElementId,
 @Size(min=1,max=50) @RequestBody @Valid
 @Size(min=1,max=50) @Valid List<DTOAccountMeasuringElementMeasureBatchUpdate> batchInput)
                                                         throws DAValidateException,
DAException

Updates multiple measures for an account's measuring element in a single batch operation.

Parameters:

accountId - the account id

measuringElementId - the measuring element id

batchInput - the list of DTOAccountMeasuringElementMeasureBatchUpdate objects containing the measure updates

Returns:

a org.springframework.http.ResponseEntity<Void> with no content on successful update

Throws:

DAValidateException - if validation fails

DAException - if a data access error occurs

batchValidate

@PostMapping(value="/validations/batch",
             produces="application/json")
public org.springframework.http.ResponseEntity<Void> batchValidate(@PathVariable("accountId")
 Long accountId,
 @PathVariable("measuringElementId")
 Long measuringElementId,
 @Size(min=1,max=50) @RequestBody @Valid
 @Size(min=1,max=50) @Valid List<DTOAccountMeasuringElementMeasureBatchStatusChange> batchInput)
                                                            throws DAValidateException,
DAException

Validates a batch of measures for a specific account's measuring element.

This endpoint performs batch validation of multiple measures belonging to the specified measuring element of an account. Each measure in the batch will be validated individually and transitioned to the validated status if all validation criteria are met.

Parameters:

accountId - the ID of the account that owns the measuring element

measuringElementId - the ID of the measuring element that owns the measures

batchInput - a list of DTOAccountMeasuringElementMeasureBatchStatusChange objects containing the IDs of measures to validate (min: 1, max: 50)

Returns:

a ResponseEntity with no content (204) indicating successful batch validation

Throws:

DAValidateException - if validation fails for any measure or if business rules are violated

DAException - if a database access error occurs during the validation process

See Also:

• DTOAccountMeasuringElementMeasureBatchStatusChange
• MeasureValidateBatchEvent
• AccountMeasuringElementValidator
• MeasuringElementMeasureValidator

batchReject

@PostMapping(value="/rejections/batch",
             produces="application/json")
public org.springframework.http.ResponseEntity<Void> batchReject(@PathVariable("accountId")
 Long accountId,
 @PathVariable("measuringElementId")
 Long measuringElementId,
 @Size(min=1,max=50) @RequestBody @Valid
 @Size(min=1,max=50) @Valid List<DTOAccountMeasuringElementMeasureBatchStatusChange> batchInput)
                                                          throws DAValidateException,
DAException

Rejects a batch of measures for a specific account's measuring element.

This endpoint performs batch rejection of multiple measures belonging to the specified measuring element of an account. Each measure in the batch will be validated individually and transitioned to the rejected status if all validation criteria are met.

Parameters:

accountId - the ID of the account that owns the measuring element

measuringElementId - the ID of the measuring element that owns the measures

batchInput - a list of DTOAccountMeasuringElementMeasureBatchStatusChange objects containing the IDs of measures to reject (min: 1, max: 50)

Returns:

a ResponseEntity with no content (204) indicating successful batch rejection

Throws:

DAValidateException - if validation fails for any measure or if business rules are violated

DAException - if a database access error occurs during the rejection process

See Also:

• DTOAccountMeasuringElementMeasureBatchStatusChange
• MeasureRejectBatchEvent
• AccountMeasuringElementValidator
• MeasuringElementMeasureValidator