Package de.digitalcollections.cudami.server.controller.identifiable.entity.geo

Class GeoLocationController

  • @RestController
@Api(description="The geo location controller",
     name="Geo location controller")
public class GeoLocationController
extends Object

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      long count()  
      de.digitalcollections.model.api.paging.PageResponse<de.digitalcollections.model.api.identifiable.entity.geo.GeoLocation> findAll​(org.springframework.boot.autoconfigure.data.web.SpringDataWebProperties.Pageable pageable, int pageNumber, int pageSize, List<de.digitalcollections.model.api.paging.Order> sortBy, String language, String initial)  
      org.springframework.http.ResponseEntity<de.digitalcollections.model.api.identifiable.entity.geo.GeoLocation> get​(UUID uuid, Locale pLocale)  
      org.springframework.http.ResponseEntity<de.digitalcollections.model.api.identifiable.entity.geo.GeoLocation> getByIdentifier​(String namespace, String id)  
      de.digitalcollections.model.api.identifiable.entity.geo.GeoLocation save​(de.digitalcollections.model.api.identifiable.entity.geo.GeoLocation geoLocation, org.springframework.validation.BindingResult errors)  
      de.digitalcollections.model.api.identifiable.entity.geo.GeoLocation update​(UUID uuid, de.digitalcollections.model.api.identifiable.entity.geo.GeoLocation geoLocation, org.springframework.validation.BindingResult errors)  

    • Constructor Detail

      • GeoLocationController

        public GeoLocationController()

    • Method Detail

      • count

        @ApiMethod(description="count all geolocations")
@GetMapping(value={"/latest/geolocations/count","/v2/geolocations/count"},
            produces="application/json")
@ApiResponseObject
public long count()

      • findAll

        @ApiMethod(description="get all geo locations")
@GetMapping(value={"/latest/geolocations","/v2/geolocations"},
            produces="application/json")
@ApiResponseObject
public de.digitalcollections.model.api.paging.PageResponse<de.digitalcollections.model.api.identifiable.entity.geo.GeoLocation> findAll​(org.springframework.boot.autoconfigure.data.web.SpringDataWebProperties.Pageable pageable,
                                                                                                                                        @RequestParam(name="pageNumber",required=false,defaultValue="0")
                                                                                                                                        int pageNumber,
                                                                                                                                        @RequestParam(name="pageSize",required=false,defaultValue="5")
                                                                                                                                        int pageSize,
                                                                                                                                        @RequestParam(name="sortBy",required=false)
                                                                                                                                        List<de.digitalcollections.model.api.paging.Order> sortBy,
                                                                                                                                        @RequestParam(name="language",required=false)
                                                                                                                                        String language,
                                                                                                                                        @RequestParam(name="initial",required=false)
                                                                                                                                        String initial)

      • get

        @ApiMethod(description="get a geolocation as JSON or XML, depending on extension or <tt>format</tt> request parameter or accept header")
@GetMapping(value={"/latest/geolocations/{uuid}","/v2/geolocations/{uuid}"},
            produces={"application/json","application/xml"})
@ApiResponseObject
public org.springframework.http.ResponseEntity<de.digitalcollections.model.api.identifiable.entity.geo.GeoLocation> get​(@ApiPathParam(description="UUID of the geolocation, e.g. <tt>599a120c-2dd5-11e8-b467-0ed5f89f718b</tt>") @PathVariable("uuid")
                                                                                                                        UUID uuid,
                                                                                                                        @ApiQueryParam(name="pLocale",description="Desired locale, e.g. <tt>de_DE</tt>. If unset, contents in all languages will be returned") @RequestParam(name="pLocale",required=false)
                                                                                                                        Locale pLocale)
                                                                                                                 throws IdentifiableServiceException
        Throws:
        IdentifiableServiceException

      • getByIdentifier

        @ApiMethod(description="get a geolocation as JSON or XML, depending on extension or <tt>format</tt> request parameter or accept header")
@GetMapping(value={"/latest/geolocations/identifier","/v2/geolocations/identifier"},
            produces={"application/json","application/xml"})
@ApiResponseObject
public org.springframework.http.ResponseEntity<de.digitalcollections.model.api.identifiable.entity.geo.GeoLocation> getByIdentifier​(@RequestParam(name="namespace",required=true)
                                                                                                                                    String namespace,
                                                                                                                                    @RequestParam(name="id",required=true)
                                                                                                                                    String id)
                                                                                                                             throws IdentifiableServiceException
        Throws:
        IdentifiableServiceException

      • save

        @ApiMethod(description="save a newly created geolocation")
@PostMapping(value={"/latest/geolocations","/v2/geolocations"},
             produces="application/json")
@ApiResponseObject
public de.digitalcollections.model.api.identifiable.entity.geo.GeoLocation save​(@RequestBody
                                                                                de.digitalcollections.model.api.identifiable.entity.geo.GeoLocation geoLocation,
                                                                                org.springframework.validation.BindingResult errors)
                                                                         throws IdentifiableServiceException
        Throws:
        IdentifiableServiceException

      • update

        @ApiMethod(description="update a geolocation")
@PutMapping(value={"/latest/geolocations/{uuid}","/v2/geolocations/{uuid}"},
            produces="application/json")
@ApiResponseObject
public de.digitalcollections.model.api.identifiable.entity.geo.GeoLocation update​(@PathVariable("uuid")
                                                                                  UUID uuid,
                                                                                  @RequestBody
                                                                                  de.digitalcollections.model.api.identifiable.entity.geo.GeoLocation geoLocation,
                                                                                  org.springframework.validation.BindingResult errors)
                                                                           throws IdentifiableServiceException
        Throws:
        IdentifiableServiceException