Class DigitalObjectController


  • @RestController
    public class DigitalObjectController
    extends AbstractIdentifiableController<de.digitalcollections.model.identifiable.entity.DigitalObject>
    • Constructor Detail

      • DigitalObjectController

        public DigitalObjectController​(DigitalObjectService digitalObjectService)
    • Method Detail

      • count

        @GetMapping(value={"/v6/digitalobjects/count","/v5/digitalobjects/count","/v2/digitalobjects/count","/latest/digitalobjects/count"},
                    produces="application/json")
        public long count()
      • delete

        @DeleteMapping(value={"/v6/digitalobjects/{uuid}","/v5/digitalobjects/{uuid}","/v2/digitalobjects/{uuid}","/latest/digitalobjects/{uuid}"},
                       produces="application/json")
        public org.springframework.http.ResponseEntity delete​(@PathVariable("uuid")
                                                              UUID uuid)
                                                       throws ConflictException
        Throws:
        ConflictException
      • find

        @GetMapping(value="/v6/digitalobjects",
                    produces="application/json")
        public de.digitalcollections.model.list.paging.PageResponse<de.digitalcollections.model.identifiable.entity.DigitalObject> find​(@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.list.sorting.Order> sortBy,
                                                                                                                                        @RequestParam(name="searchTerm",required=false)
                                                                                                                                        String searchTerm,
                                                                                                                                        @RequestParam(name="parent.uuid",required=false)
                                                                                                                                        de.digitalcollections.model.list.filtering.FilterCriterion<UUID> parentUuidFilterCriterion,
                                                                                                                                        @RequestParam(name="label",required=false)
                                                                                                                                        String labelTerm,
                                                                                                                                        @RequestParam(name="labelLanguage",required=false)
                                                                                                                                        Locale labelLanguage)
      • findProjects

        @GetMapping(value="/v6/digitalobjects/{uuid}/projects",
                    produces="application/json")
        public de.digitalcollections.model.list.paging.PageResponse<de.digitalcollections.model.identifiable.entity.Project> findProjects​(@PathVariable("uuid")
                                                                                                                                          UUID uuid,
                                                                                                                                          @RequestParam(name="pageNumber",required=false,defaultValue="0")
                                                                                                                                          int pageNumber,
                                                                                                                                          @RequestParam(name="pageSize",required=false,defaultValue="25")
                                                                                                                                          int pageSize,
                                                                                                                                          @RequestParam(name="searchTerm",required=false)
                                                                                                                                          String searchTerm)
      • getAllReduced

        @GetMapping(value={"/v6/digitalobjects/reduced","/v5/digitalobjects/reduced","/v3/digitalobjects/reduced","/latest/digitalobjects/reduced"},
                    produces="application/json")
        public List<de.digitalcollections.model.identifiable.entity.DigitalObject> getAllReduced()
      • getByIdentifier

        @GetMapping(value={"/v6/digitalobjects/identifier/**","/v5/digitalobjects/identifier/**","/v2/digitalobjects/identifier/**","/latest/digitalobjects/identifier/**"},
                    produces="application/json")
        public org.springframework.http.ResponseEntity<de.digitalcollections.model.identifiable.entity.DigitalObject> getByIdentifier​(javax.servlet.http.HttpServletRequest request,
                                                                                                                                      @RequestParam(name="fill-wemi",required=false,defaultValue="false")
                                                                                                                                      boolean fillWemi)
                                                                                                                               throws IdentifiableServiceException,
                                                                                                                                      ValidationException
        Throws:
        IdentifiableServiceException
        ValidationException
      • getByRefId

        @GetMapping(value="/v5/digitalobjects/{refId:[0-9]+}",
                    produces="application/json")
        public de.digitalcollections.model.identifiable.entity.DigitalObject getByRefId​(@PathVariable
                                                                                        long refId)
      • getByUuid

        @GetMapping(value={"/v6/digitalobjects/{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}}","/v5/digitalobjects/{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/digitalobjects/{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}}","/latest/digitalobjects/{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")
        public de.digitalcollections.model.identifiable.entity.DigitalObject getByUuid​(@PathVariable
                                                                                       UUID uuid)
      • getCollections

        @GetMapping(value="/v6/digitalobjects/{uuid}/collections",
                    produces="application/json")
        public de.digitalcollections.model.list.paging.PageResponse<de.digitalcollections.model.identifiable.entity.Collection> getCollections​(@PathVariable("uuid")
                                                                                                                                               UUID uuid,
                                                                                                                                               @RequestParam(name="pageNumber",required=false,defaultValue="0")
                                                                                                                                               int pageNumber,
                                                                                                                                               @RequestParam(name="pageSize",required=false,defaultValue="25")
                                                                                                                                               int pageSize,
                                                                                                                                               @RequestParam(name="active",required=false)
                                                                                                                                               String active,
                                                                                                                                               @RequestParam(name="searchTerm",required=false)
                                                                                                                                               String searchTerm)
      • getFileResources

        @GetMapping(value={"/v6/digitalobjects/{uuid}/fileresources","/v5/digitalobjects/{uuid}/fileresources","/v2/digitalobjects/{uuid}/fileresources","/latest/digitalobjects/{uuid}/fileresources"},
                    produces="application/json")
        public List<de.digitalcollections.model.identifiable.resource.FileResource> getFileResources​(@PathVariable
                                                                                                     UUID uuid)
      • getImageFileResources

        @GetMapping(value={"/v6/digitalobjects/{uuid}/fileresources/images","/v5/digitalobjects/{uuid}/fileresources/images","/v2/digitalobjects/{uuid}/fileresources/images","/latest/digitalobjects/{uuid}/fileresources/images"},
                    produces="application/json")
        public List<de.digitalcollections.model.identifiable.resource.ImageFileResource> getImageFileResources​(@PathVariable
                                                                                                               UUID uuid)
      • getItem

        @GetMapping(value={"/v6/digitalobjects/{uuid}/item","/v5/digitalobjects/{uuid}/item","/v2/digitalobjects/{uuid}/item","/latest/digitalobjects/{uuid}/item"},
                    produces="application/json")
        public de.digitalcollections.model.identifiable.entity.work.Item getItem​(@PathVariable
                                                                                 UUID uuid)
      • getLanguages

        @GetMapping(value={"/v6/digitalobjects/languages","/v5/digitalobjects/languages","/v3/digitalobjects/languages","/latest/digitalobjects/languages"},
                    produces="application/json")
        public List<Locale> getLanguages​(@RequestParam(name="parent.uuid",required=false)
                                         de.digitalcollections.model.list.filtering.FilterCriterion<UUID> parentUuidFilterCriterion)
      • getLanguagesOfCollections

        @GetMapping(value={"/v6/digitalobjects/{uuid}/collections/languages","/v5/digitalobjects/{uuid}/collections/languages"},
                    produces="application/json")
        public List<Locale> getLanguagesOfCollections​(@PathVariable
                                                      UUID uuid)
      • getLanguagesOfProjects

        @GetMapping(value={"/v6/digitalobjects/{uuid}/projects/languages","/v5/digitalobjects/{uuid}/projects/languages"},
                    produces="application/json")
        public List<Locale> getLanguagesOfProjects​(@PathVariable
                                                   UUID uuid)
      • getRandomDigitalObjects

        @GetMapping(value={"/v6/digitalobjects/random","/v5/digitalobjects/random","/v2/digitalobjects/random","/latest/digitalobjects/random"},
                    produces="application/json")
        public List<de.digitalcollections.model.identifiable.entity.DigitalObject> getRandomDigitalObjects​(@RequestParam(name="count",required=false,defaultValue="5")
                                                                                                           int count)
      • save

        @PostMapping(value={"/v6/digitalobjects","/v5/digitalobjects","/v2/digitalobjects","/latest/digitalobjects"},
                     produces="application/json")
        public de.digitalcollections.model.identifiable.entity.DigitalObject save​(@RequestBody
                                                                                  de.digitalcollections.model.identifiable.entity.DigitalObject digitalObject,
                                                                                  org.springframework.validation.BindingResult errors)
                                                                           throws IdentifiableServiceException,
                                                                                  ValidationException
        Throws:
        IdentifiableServiceException
        ValidationException
      • setFileResources

        @PostMapping(value={"/v6/digitalobjects/{uuid}/fileresources","/v5/digitalobjects/{uuid}/fileresources","/v3/digitalobjects/{uuid}/fileresources","/latest/digitalobjects/{uuid}/fileresources"},
                     produces="application/json")
        public List<de.digitalcollections.model.identifiable.resource.FileResource> setFileResources​(@PathVariable("uuid")
                                                                                                     UUID uuid,
                                                                                                     @RequestBody
                                                                                                     List<de.digitalcollections.model.identifiable.resource.FileResource> fileResources)
      • update

        @PutMapping(value={"/v6/digitalobjects/{uuid}","/v5/digitalobjects/{uuid}","/v2/digitalobjects/{uuid}","/latest/digitalobjects/{uuid}"},
                    produces="application/json")
        public de.digitalcollections.model.identifiable.entity.DigitalObject update​(@PathVariable("uuid")
                                                                                    UUID uuid,
                                                                                    @RequestBody
                                                                                    de.digitalcollections.model.identifiable.entity.DigitalObject digitalObject,
                                                                                    org.springframework.validation.BindingResult errors)
                                                                             throws IdentifiableServiceException,
                                                                                    ValidationException
        Throws:
        IdentifiableServiceException
        ValidationException