Package overit.geocallapp.wfm.characteristics.rs1.characteristic

Class CharacteristicService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.characteristics.rs1.characteristic.CharacteristicService

@RestController
@RequestMapping("configurations/characteristics/r1/characteristics")
@Resource(logging=true)
public class CharacteristicService
extends PrivateService

Service to manage characteristics.

Since:

16.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
CharacteristicService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOCharacteristic>	get(Long characteristicId, @Valid String language, Collection<String> fields)	Retrieves the required DTOCharacteristic by calling from the CharacteristicLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOCharacteristic>>	getCollection(@Valid Page page, Collection<String> fields, String order, @Valid String language, @Valid DTOCharacteristicFilter filter)	Returns the collection of all the stored characteristics by calling the CharacteristicSearchEvent.
org.springframework.http.ResponseEntity<Void>	patch(Long characteristicId, @Valid DTOCharacteristicUpdate dto)	Updates a characteristic by calling the CharacteristicUpdateEvent.
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(@Valid DTOCharacteristicInsert dto)	Creates a new characteristic by calling the CharacteristicInsertEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

CharacteristicService

public CharacteristicService()

Method Details

getCollection

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

Returns the collection of all the stored characteristics by calling the CharacteristicSearchEvent.

Parameters:

page - the Page that will contain the paginated result

fields - the collection of fields the response will contain

order - the ordering field

language - the user language

filter - the DTOCharacteristicFilter

Returns:

the collection of DTOCharacteristic

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required DTOCharacteristic by calling from the CharacteristicLoadEvent.

Parameters:

characteristicId - the characteristic id

language - the user language

fields - the collection of fields the response will contain

Returns:

the response containing the required characteristic

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

Creates a new characteristic by calling the CharacteristicInsertEvent.

Parameters:

dto - the DTOCharacteristicInsert

Returns:

the standard response containing the new characteristic id

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patch

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

Updates a characteristic by calling the CharacteristicUpdateEvent.

Parameters:

characteristicId - the characteristic id

dto - the DTOCharacteristicUpdate

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception