Package overit.geocallapp.wfm.catalogs.rs1.catalogcode

Class CatalogCodeService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.catalogs.rs1.catalogcode.CatalogCodeService

@RestController
@RequestMapping("configurations/catalogs/r1/catalog-codes")
@Resource(logging=true)
public class CatalogCodeService
extends PrivateService

Service to manage catalog codes.

Since:

20.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
CatalogCodeService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOCatalogCode>	get(Long id, Collection<String> fields)	Retrieves the required DTOCatalogCode by calling the CatalogCodeLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOCatalogCode>>	getCollection(@Valid Page page, Collection<String> fields, String order, @Valid DTOCatalogCodeFilter filter)	Returns the collection of all the stored catalog codes by calling the CatalogCodeSearchEvent.
org.springframework.http.ResponseEntity<Void>	patch(Long id, @Valid DTOCatalogCodeUpdate dto)	Modifies the required DTOCatalogCode by calling the CatalogCodeUpdateEvent.
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(@Valid DTOCatalogCodeInsert dto)	Creates a new DTOCatalogCode by calling the CatalogCodeInsertEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

CatalogCodeService

public CatalogCodeService()

Method Details

getCollection

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

Returns the collection of all the stored catalog codes by calling the CatalogCodeSearchEvent.

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 DTOCatalogCodeFilter

Returns:

the collection of DTOCatalogCode

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required DTOCatalogCode by calling the CatalogCodeLoadEvent.

Parameters:

id - the catalog code id

fields - the collection of fields the response will contain

Returns:

the response containing the loaded catalog code

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

Creates a new DTOCatalogCode by calling the CatalogCodeInsertEvent.

Parameters:

dto - the DTOCatalogCodeInsert

Returns:

the standard response containing the new catalog code id

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patch

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

Modifies the required DTOCatalogCode by calling the CatalogCodeUpdateEvent.

Parameters:

id - the catalog code id

dto - the DTOCatalogCodeUpdate

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception