Package overit.geocallapp.wfm.catalogs.rs1.cataloggroup

Class CatalogGroupService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.catalogs.rs1.cataloggroup.CatalogGroupService

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

Service to manage catalog groups.

Since:

20.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
CatalogGroupService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOCatalogGroup>	get(Long catalogGroupId, Collection<String> fields)	Retrieves the required DTOCatalogGroup by calling the CatalogGroupLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOCatalogGroup>>	getCollection(@Valid Page page, Collection<String> fields, String order, @Valid DTOCatalogGroupFilter filter)	Returns the collection of all the stored catalog groups by calling the CatalogGroupSearchEvent.
org.springframework.http.ResponseEntity<Void>	patch(Long catalogGroupId, @Valid DTOCatalogGroupUpdate dto)	Modifies the required DTOCatalogGroup by calling the CatalogGroupUpdateEvent.
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(@Valid DTOCatalogGroupInsert dto)	Creates a new DTOCatalogGroup by calling the CatalogGroupInsertEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

CatalogGroupService

public CatalogGroupService()

Method Details

getCollection

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

Returns the collection of all the stored catalog groups by calling the CatalogGroupSearchEvent.

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 DTOCatalogGroupFilter

Returns:

the collection of DTOCatalogGroup

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required DTOCatalogGroup by calling the CatalogGroupLoadEvent.

Parameters:

catalogGroupId - the catalog group id

fields - the collection of fields the response will contain

Returns:

the response containing the loaded catalog group

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

Creates a new DTOCatalogGroup by calling the CatalogGroupInsertEvent.

Parameters:

dto - the DTOCatalogGroupInsert

Returns:

the standard response containing the new catalog group id

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patch

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

Modifies the required DTOCatalogGroup by calling the CatalogGroupUpdateEvent.

Parameters:

catalogGroupId - the catalog group id

dto - the DTOCatalogGroupUpdate

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception