Package overit.geocallapp.wfm.core.rs5.location.region

Class RegionService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.core.rs5.location.region.RegionService

@RestController
@RequestMapping("core/r5/location/regions")
@Resource(logging=true)
public class RegionService
extends PrivateService

Services to manage regions.

Since:

19.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
RegionService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTORegion>	get(Long id)	Retrieves the required region.
org.springframework.http.ResponseEntity<PageResponse<DTORegion>>	getCollection(@NotNull @Valid Page page, @Valid @NotNull DTORegionSearchFilter filter)	Retrieve the all stored regions.

Methods inherited from class java.lang.Object

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

Constructor Details

RegionService

public RegionService()

Method Details

getCollection

@GetMapping(produces="application/json")
public org.springframework.http.ResponseEntity<PageResponse<DTORegion>> getCollection(@RequestParam("page") @NotNull @Valid
 @NotNull @Valid Page page,
 @RequestParam("filter") @Valid @NotNull
 @Valid @NotNull DTORegionSearchFilter filter)
                                                                               throws DAValidateException,
DAException

Retrieve the all stored regions. RegionSearchEvent

Parameters:

page - the required result page

filter - the specified DTORegionSearchFilter

Returns:

the response containing the current result page

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

@GetMapping(value="{id:[0-9]+}",
            produces="application/json")
public org.springframework.http.ResponseEntity<DTORegion> get(@PathVariable("id")
 Long id)
                                                       throws DAValidateException,
DAException

Retrieves the required region. RegionLoadEvent

Parameters:

id - region id

Returns:

the response containing the required region

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception