Package overit.geocallapp.wfm.accounts.rs1.convertertype

Class ConverterTypeService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.accounts.rs1.convertertype.ConverterTypeService

@RestController
@RequestMapping("assets/accounts/r1/converter-types")
@Resource(logging=true)
public class ConverterTypeService
extends PrivateService

Service to manage converter type

Since:

16.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
ConverterTypeService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOConverterType>	get(Long converterTypeId, Collection<String> fields)	Retrieves the required DTOConverterType by calling the ConverterTypeLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOConverterType>>	getCollection(@Valid Page page, Collection<String> fields, String order, @Valid DTOConverterTypeFilter filter)	Returns the collection of all the stored converter type by calling the ConverterTypeSearchEvent.
org.springframework.http.ResponseEntity<Void>	patch(Long converterTypeId, @Valid DTOConverterTypeUpdate dto)	Update a converter type by calling the ConverterTypeUpdateEvent
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(@Valid DTOConverterTypeInsert dto)	Create a new converter type by calling the ConverterTypeInsertEvent

Methods inherited from class java.lang.Object

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

Constructor Details

ConverterTypeService

public ConverterTypeService()

Method Details

getCollection

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

Returns the collection of all the stored converter type by calling the ConverterTypeSearchEvent.

Parameters:

page - the Page that will contain the paginated result

fields - the collection of fields the response will contain

order - the ordering field

filter - the DTOConverterTypeFilter

Returns:

the collection of DTOConverterType

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required DTOConverterType by calling the ConverterTypeLoadEvent.

Parameters:

converterTypeId - the converter type id

fields - the collection of fields the response will contain

Returns:

the response containing the loaded converter 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 DTOConverterTypeInsert dto)
                                                                  throws DAValidateException,
DAException

Create a new converter type by calling the ConverterTypeInsertEvent

Parameters:

dto - the DTOConverterTypeInsert

Returns:

the standard response containing the new converter type id

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patch

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

Update a converter type by calling the ConverterTypeUpdateEvent

Parameters:

converterTypeId - the converter tpe id

dto - the DTOConverterTypeUpdate

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception