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

Class ProjectController

java.lang.Object
de.digitalcollections.cudami.server.controller.identifiable.entity.ProjectController
@RestController
@Api(description="The project controller",
     name="Project controller")
public class ProjectController
extends java.lang.Object

  • Constructor Summary

    Constructors 
    Constructor Description
    ProjectController​(ProjectService projectService)  

  • Method Summary

    Modifier and Type Method Description
    org.springframework.http.ResponseEntity addDigitalObject​(java.util.UUID projectUuid, java.util.UUID digitalObjectUuid)  
    org.springframework.http.ResponseEntity addDigitalObjects​(java.util.UUID projectUuid, java.util.List<de.digitalcollections.model.api.identifiable.entity.DigitalObject> digitalObjects)  
    org.springframework.http.ResponseEntity deleteProject​(java.util.UUID uuid)  
    de.digitalcollections.model.api.paging.PageResponse<de.digitalcollections.model.api.identifiable.entity.Project> findAll​(int pageNumber, int pageSize, java.util.List<de.digitalcollections.model.api.paging.Order> sortBy)  
    java.util.List<de.digitalcollections.model.api.identifiable.entity.Project> findAllReducedAsList()  
    de.digitalcollections.model.api.identifiable.entity.Project findByIdentifier​(java.lang.String namespace, java.lang.String id)  
    org.springframework.http.ResponseEntity<de.digitalcollections.model.api.identifiable.entity.Project> findByUuid​(java.util.UUID uuid, java.util.Locale pLocale)  
    de.digitalcollections.model.api.paging.PageResponse<de.digitalcollections.model.api.identifiable.entity.DigitalObject> getDigitalObjects​(java.util.UUID projectUuid, int pageNumber, int pageSize)  
    org.springframework.http.ResponseEntity removeDigitalObject​(java.util.UUID projectUuid, java.util.UUID digitalObjectUuid)  
    de.digitalcollections.model.api.identifiable.entity.Project save​(de.digitalcollections.model.api.identifiable.entity.Project project, org.springframework.validation.BindingResult errors)  
    org.springframework.http.ResponseEntity saveDigitalObjects​(java.util.UUID projectUuid, java.util.List<de.digitalcollections.model.api.identifiable.entity.DigitalObject> digitalObjects)  
    de.digitalcollections.model.api.identifiable.entity.Project update​(java.util.UUID uuid, de.digitalcollections.model.api.identifiable.entity.Project project, org.springframework.validation.BindingResult errors)  

    Methods inherited from class java.lang.Object

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

  • Constructor Details

  • Method Details

    • addDigitalObject

      @ApiMethod(description="Add an existing digital object to an existing project") @PostMapping(value={"/latest/projects/{uuid}/digitalobjects/{digitalObjectUuid}","/v3/projects/{uuid}/digitalobjects/{digitalObjectUuid}"}, produces="application/json") @ApiResponseObject public org.springframework.http.ResponseEntity addDigitalObject​(@ApiPathParam(description="UUID of the project") @PathVariable("uuid") java.util.UUID projectUuid, @ApiPathParam(description="UUID of the digital object") @PathVariable("digitalObjectUuid") java.util.UUID digitalObjectUuid)

    • addDigitalObjects

      @ApiMethod(description="Add existing digital objects to an existing project") @PostMapping(value={"/latest/projects/{uuid}/digitalobjects","/v3/projects/{uuid}/digitalobjects"}, produces="application/json") @ApiResponseObject public org.springframework.http.ResponseEntity addDigitalObjects​(@ApiPathParam(description="UUID of the project") @PathVariable("uuid") java.util.UUID projectUuid, @ApiPathParam(description="List of the digital objects") @RequestBody java.util.List<de.digitalcollections.model.api.identifiable.entity.DigitalObject> digitalObjects)

    • deleteProject

      @ApiMethod(description="Delete an existing project and the identifiers, which belong to this project") @DeleteMapping(value={"/latest/projects/{uuid}","/v3/projects/{uuid}"}, produces="application/json") @ApiResponseObject public org.springframework.http.ResponseEntity deleteProject​(@ApiPathParam(description="UUID of the project") @PathVariable("uuid") java.util.UUID uuid)

    • findAll

      @ApiMethod(description="Get all projects in reduced form (no identifiers)") @GetMapping(value={"/latest/projects","/v2/projects"}, produces="application/json") @ApiResponseObject public de.digitalcollections.model.api.paging.PageResponse<de.digitalcollections.model.api.identifiable.entity.Project> findAll​(@RequestParam(name="pageNumber",required=false,defaultValue="0") int pageNumber, @RequestParam(name="pageSize",required=false,defaultValue="25") int pageSize, @RequestParam(name="sortBy",required=false) java.util.List<de.digitalcollections.model.api.paging.Order> sortBy)

    • findAllReducedAsList

      @ApiMethod(description="Get all projects as list") @GetMapping(value={"/latest/projectlist","/v2/projectlist"}, produces="application/json") @ApiResponseObject public java.util.List<de.digitalcollections.model.api.identifiable.entity.Project> findAllReducedAsList()

    • findByIdentifier

      @ApiMethod(description="Get project by namespace and id") @GetMapping(value={"/latest/projects/identifier/{namespace}:{id}","/v3/projects/identifier/{namespace}:{id}"}, produces="application/json") @ApiResponseObject public de.digitalcollections.model.api.identifiable.entity.Project findByIdentifier​(@PathVariable java.lang.String namespace, @PathVariable java.lang.String id) throws IdentifiableServiceException
      Throws:
      IdentifiableServiceException

    • findByUuid

      @ApiMethod(description="Get an project as JSON or XML, depending on extension or <tt>format</tt> request parameter or accept header") @GetMapping(value={"/latest/projects/{uuid}","/v2/projects/{uuid}"}, produces={"application/json","application/xml"}) @ApiResponseObject public org.springframework.http.ResponseEntity<de.digitalcollections.model.api.identifiable.entity.Project> findByUuid​(@ApiPathParam(description="UUID of the project, e.g. <tt>599a120c-2dd5-11e8-b467-0ed5f89f718b</tt>") @PathVariable("uuid") java.util.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) java.util.Locale pLocale) throws IdentifiableServiceException
      Throws:
      IdentifiableServiceException

    • getDigitalObjects

      @ApiMethod(description="Get paged digital objects of a project") @GetMapping(value={"/latest/projects/{uuid}/digitalobjects","/v3/projects/{uuid}/digitalobjects"}, produces="application/json") @ApiResponseObject public de.digitalcollections.model.api.paging.PageResponse<de.digitalcollections.model.api.identifiable.entity.DigitalObject> getDigitalObjects​(@ApiPathParam(description="UUID of the project") @PathVariable("uuid") java.util.UUID projectUuid, @RequestParam(name="pageNumber",required=false,defaultValue="0") int pageNumber, @RequestParam(name="pageSize",required=false,defaultValue="25") int pageSize)

    • removeDigitalObject

      @ApiMethod(description="Remove an existing digital object from an existing project") @DeleteMapping(value={"/latest/projects/{uuid}/digitalobjects/{digitalObjectUuid}","/v3/projects/{uuid}/digitalobjects/{digitalObjectUuid}"}, produces="application/json") @ApiResponseObject public org.springframework.http.ResponseEntity removeDigitalObject​(@ApiPathParam(description="UUID of the project") @PathVariable("uuid") java.util.UUID projectUuid, @ApiPathParam(description="UUID of the digital object") @PathVariable("digitalObjectUuid") java.util.UUID digitalObjectUuid)

    • save

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

    • saveDigitalObjects

      @ApiMethod(description="Save existing digital objects into an existing project") @PutMapping(value={"/latest/projects/{uuid}/digitalobjects","/v3/projects/{uuid}/digitalobjects"}, produces="application/json") @ApiResponseObject public org.springframework.http.ResponseEntity saveDigitalObjects​(@ApiPathParam(description="UUID of the project") @PathVariable("uuid") java.util.UUID projectUuid, @ApiPathParam(description="List of the digital objects") @RequestBody java.util.List<de.digitalcollections.model.api.identifiable.entity.DigitalObject> digitalObjects)

    • update

      @ApiMethod(description="Update an project") @PutMapping(value={"/latest/projects/{uuid}","/v2/projects/{uuid}"}, produces="application/json") @ApiResponseObject public de.digitalcollections.model.api.identifiable.entity.Project update​(@PathVariable java.util.UUID uuid, @RequestBody de.digitalcollections.model.api.identifiable.entity.Project project, org.springframework.validation.BindingResult errors) throws IdentifiableServiceException
      Throws:
      IdentifiableServiceException