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

Class FamilyNameController

java.lang.Object

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

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

Constructor Summary

Constructors

Constructor	Description
FamilyNameController()

Method Summary

Modifier and Type	Method	Description
de.digitalcollections.model.api.paging.PageResponse<de.digitalcollections.model.api.identifiable.agent.FamilyName>	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.FamilyName>	get(UUID uuid, Locale pLocale)
org.springframework.http.ResponseEntity<de.digitalcollections.model.api.identifiable.agent.FamilyName>	getByIdentifier(String namespace, String id)
de.digitalcollections.model.api.identifiable.agent.FamilyName	save(de.digitalcollections.model.api.identifiable.agent.FamilyName familyName, org.springframework.validation.BindingResult errors)
de.digitalcollections.model.api.identifiable.agent.FamilyName	update(UUID uuid, de.digitalcollections.model.api.identifiable.agent.FamilyName familyName, 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

FamilyNameController

public FamilyNameController()

Method Detail

findAll

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

Throws:

IdentifiableServiceException

update

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

Throws:

IdentifiableServiceException