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

Class CorporationController

  • @RestController
@Api(description="The corporation controller",
     name="Corporation controller")
public class CorporationController
extends Object

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      de.digitalcollections.model.api.identifiable.entity.Corporation fetchAndSaveByGndId​(String gndId)  
      de.digitalcollections.model.api.paging.PageResponse<de.digitalcollections.model.api.identifiable.entity.Corporation> findAll​(int pageNumber, int pageSize, String sortField, de.digitalcollections.model.api.paging.enums.Direction sortDirection, de.digitalcollections.model.api.paging.enums.NullHandling nullHandling)  
      org.springframework.http.ResponseEntity<de.digitalcollections.model.api.identifiable.entity.Corporation> get​(UUID uuid, Locale pLocale)  
      de.digitalcollections.model.api.identifiable.entity.Corporation getByIdentifier​(String namespace, String id)  
      de.digitalcollections.model.api.identifiable.entity.Corporation getByRefId​(long refId)  
      de.digitalcollections.model.api.identifiable.entity.Corporation save​(de.digitalcollections.model.api.identifiable.entity.Corporation corporation, org.springframework.validation.BindingResult errors)  
      de.digitalcollections.model.api.identifiable.entity.Corporation update​(UUID uuid, de.digitalcollections.model.api.identifiable.entity.Corporation corporation, org.springframework.validation.BindingResult errors)  

    • Constructor Detail

      • CorporationController

        @Autowired
public CorporationController​(CorporationService corporationService)

    • Method Detail

      • fetchAndSaveByGndId

        @ApiMethod(description="Fetch a corporation by GND-ID from external system and save it")
@PostMapping(value={"/latest/corporations/gnd/{gndId}","/v3/corporations/gnd/{gndId}"},
             produces="application/json")
@ApiResponseObject
public de.digitalcollections.model.api.identifiable.entity.Corporation fetchAndSaveByGndId​(@ApiPathParam(description="GND-ID of the corporation, e.g. <tt>2007744-0</tt>") @PathVariable("gndId")
                                                                                           String gndId)
                                                                                    throws IdentifiableServiceException
        Throws:
        IdentifiableServiceException

      • findAll

        @ApiMethod(description="Get all corporations")
@GetMapping(value={"/latest/corporations","/v2/corporations"},
            produces="application/json")
@ApiResponseObject
public de.digitalcollections.model.api.paging.PageResponse<de.digitalcollections.model.api.identifiable.entity.Corporation> findAll​(@RequestParam(name="pageNumber",required=false,defaultValue="0")
                                                                                                                                    int pageNumber,
                                                                                                                                    @RequestParam(name="pageSize",required=false,defaultValue="25")
                                                                                                                                    int pageSize,
                                                                                                                                    @RequestParam(name="sortField",required=false,defaultValue="lastModified")
                                                                                                                                    String sortField,
                                                                                                                                    @RequestParam(name="sortDirection",required=false,defaultValue="DESC")
                                                                                                                                    de.digitalcollections.model.api.paging.enums.Direction sortDirection,
                                                                                                                                    @RequestParam(name="nullHandling",required=false,defaultValue="NATIVE")
                                                                                                                                    de.digitalcollections.model.api.paging.enums.NullHandling nullHandling)

      • get

        @ApiMethod(description="Get an corporation as JSON or XML, depending on extension or <tt>format</tt> request parameter or accept header")
@GetMapping(value={"/latest/corporations/{uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}}","/v2/corporations/{uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}}"},
            produces={"application/json","application/xml"})
@ApiResponseObject
public org.springframework.http.ResponseEntity<de.digitalcollections.model.api.identifiable.entity.Corporation> get​(@ApiPathParam(description="UUID of the corporation, 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 corporation by namespace and id")
@GetMapping(value={"/latest/corporations/identifier/{namespace}:{id}","/v3/corporations/identifier/{namespace}:{id}"},
            produces="application/json")
@ApiResponseObject
public de.digitalcollections.model.api.identifiable.entity.Corporation getByIdentifier​(@ApiPathParam(description="namespace of identifier") @PathVariable("namespace")
                                                                                       String namespace,
                                                                                       @ApiPathParam(description="id of identifier") @PathVariable("id")
                                                                                       String id)
                                                                                throws IdentifiableServiceException
        Throws:
        IdentifiableServiceException

      • getByRefId

        @ApiMethod(description="Get corporation by refId")
@GetMapping(value={"/latest/corporations/{refId:[0-9]+}","/v3/corporations/{refId:[0-9]+}"},
            produces="application/json")
@ApiResponseObject
public de.digitalcollections.model.api.identifiable.entity.Corporation getByRefId​(@ApiPathParam(description="reference id") @PathVariable("refId")
                                                                                  long refId)
                                                                           throws IdentifiableServiceException
        Throws:
        IdentifiableServiceException

      • save

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

      • update

        @ApiMethod(description="Update an corporation")
@PutMapping(value={"/latest/corporations/{uuid}","/v2/corporations/{uuid}"},
            produces="application/json")
@ApiResponseObject
public de.digitalcollections.model.api.identifiable.entity.Corporation update​(@ApiPathParam(description="UUID of the corporation, e.g. <tt>599a120c-2dd5-11e8-b467-0ed5f89f718b</tt>") @PathVariable("uuid")
                                                                              UUID uuid,
                                                                              @RequestBody
                                                                              de.digitalcollections.model.api.identifiable.entity.Corporation corporation,
                                                                              org.springframework.validation.BindingResult errors)
                                                                       throws IdentifiableServiceException
        Throws:
        IdentifiableServiceException