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

Class GivenNameController

java.lang.Object

de.digitalcollections.cudami.server.controller.identifiable.agent.GivenNameController

@RestController
@Api(description="The GivenName controller",
     name="GivenName controller")
public class GivenNameController
extends Object

Constructor Summary

Constructors

Constructor	Description
GivenNameController()

Method Summary

Modifier and Type	Method	Description
de.digitalcollections.model.api.paging.PageResponse<de.digitalcollections.model.api.identifiable.agent.GivenName>	findAll(org.springframework.boot.autoconfigure.data.web.SpringDataWebProperties.Pageable pageable, int pageNumber, int pageSize, String sortField, de.digitalcollections.model.api.paging.enums.Direction sortDirection, de.digitalcollections.model.api.paging.enums.NullHandling nullHandling, String language, String initial)
org.springframework.http.ResponseEntity<de.digitalcollections.model.api.identifiable.agent.GivenName>	get(UUID uuid, Locale pLocale)
org.springframework.http.ResponseEntity<de.digitalcollections.model.api.identifiable.agent.GivenName>	getByIdentifier(String namespace, String id)
de.digitalcollections.model.api.identifiable.agent.GivenName	save(de.digitalcollections.model.api.identifiable.agent.GivenName givenName, org.springframework.validation.BindingResult errors)
de.digitalcollections.model.api.identifiable.agent.GivenName	update(UUID uuid, de.digitalcollections.model.api.identifiable.agent.GivenName givenName, org.springframework.validation.BindingResult errors)

Methods inherited from class java.lang.Object

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

Constructor Detail

GivenNameController

public GivenNameController()

Method Detail

findAll

@ApiMethod(description="get all given names")
@GetMapping(value={"/latest/givennames","/v2/givennames"},
            produces="application/json")
@ApiResponseObject
public de.digitalcollections.model.api.paging.PageResponse<de.digitalcollections.model.api.identifiable.agent.GivenName> 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="sortField",required=false,defaultValue="uuid")
                                                                                                                                 String sortField,
                                                                                                                                 @RequestParam(name="sortDirection",required=false,defaultValue="ASC")
                                                                                                                                 de.digitalcollections.model.api.paging.enums.Direction sortDirection,
                                                                                                                                 @RequestParam(name="nullHandling",required=false,defaultValue="NATIVE")
                                                                                                                                 de.digitalcollections.model.api.paging.enums.NullHandling nullHandling,
                                                                                                                                 @RequestParam(name="language",required=false,defaultValue="de")
                                                                                                                                 String language,
                                                                                                                                 @RequestParam(name="initial",required=false)
                                                                                                                                 String initial)

get

@ApiMethod(description="get a givenname as JSON or XML, depending on extension or <tt>format</tt> request parameter or accept header")
@GetMapping(value={"/latest/givennames/{uuid}","/v2/givennames/{uuid}"},
            produces={"application/json","application/xml"})
@ApiResponseObject
public org.springframework.http.ResponseEntity<de.digitalcollections.model.api.identifiable.agent.GivenName> get(@ApiPathParam(description="UUID of the givenname, 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 givenname as JSON or XML, depending on extension or <tt>format</tt> request parameter or accept header")
@GetMapping(value={"/latest/givennames/identifier","/v2/givennames/identifier"},
            produces={"application/json","application/xml"})
@ApiResponseObject
public org.springframework.http.ResponseEntity<de.digitalcollections.model.api.identifiable.agent.GivenName> 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 givenname")
@PostMapping(value={"/latest/givennames","/v2/givennames"},
             produces="application/json")
@ApiResponseObject
public de.digitalcollections.model.api.identifiable.agent.GivenName save(@RequestBody
                                                                         de.digitalcollections.model.api.identifiable.agent.GivenName givenName,
                                                                         org.springframework.validation.BindingResult errors)
                                                                  throws IdentifiableServiceException

Throws:

IdentifiableServiceException

update

@ApiMethod(description="update a givenname")
@PutMapping(value={"/latest/givennames/{uuid}","/v2/givennames/{uuid}"},
            produces="application/json")
@ApiResponseObject
public de.digitalcollections.model.api.identifiable.agent.GivenName update(@PathVariable("uuid")
                                                                           UUID uuid,
                                                                           @RequestBody
                                                                           de.digitalcollections.model.api.identifiable.agent.GivenName givenName,
                                                                           org.springframework.validation.BindingResult errors)
                                                                    throws IdentifiableServiceException

Throws:

IdentifiableServiceException