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

Class ContentNodeController

  • @RestController
@Api(description="The content node controller",
     name="ContentNode controller")
public class ContentNodeController
extends java.lang.Object

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addIdentifiable​(java.util.UUID uuid, java.util.UUID identifiableUuid)  
      long count()  
      de.digitalcollections.model.api.paging.PageResponse<de.digitalcollections.model.api.identifiable.entity.parts.ContentNode> findAll​(int pageNumber, int pageSize, java.lang.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.parts.ContentNode> getContentNode​(java.util.UUID uuid, java.util.Locale pLocale)  
      java.util.List<de.digitalcollections.model.api.identifiable.Identifiable> getIdentifiables​(java.util.UUID uuid)  
      java.util.List<de.digitalcollections.model.api.identifiable.Identifiable> saveIdentifiables​(java.util.UUID uuid, java.util.List<de.digitalcollections.model.api.identifiable.Identifiable> identifiables)  
      de.digitalcollections.model.api.identifiable.entity.parts.ContentNode saveWithParentContentNode​(java.util.UUID parentContentNodeUuid, de.digitalcollections.model.api.identifiable.entity.parts.ContentNode contentNode, org.springframework.validation.BindingResult errors)  
      de.digitalcollections.model.api.identifiable.entity.parts.ContentNode saveWithParentContentTree​(java.util.UUID parentContentTreeUuid, de.digitalcollections.model.api.identifiable.entity.parts.ContentNode contentNode, org.springframework.validation.BindingResult errors)  
      de.digitalcollections.model.api.identifiable.entity.parts.ContentNode update​(java.util.UUID uuid, de.digitalcollections.model.api.identifiable.entity.parts.ContentNode contentNode, 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

      • ContentNodeController

        public ContentNodeController()

    • Method Detail

      • findAll

        @ApiMethod(description="get all content nodes")
@RequestMapping(value={"/latest/contentnodes","/v2/contentnodes"},
                produces="application/json",
                method=GET)
@ApiResponseObject
public de.digitalcollections.model.api.paging.PageResponse<de.digitalcollections.model.api.identifiable.entity.parts.ContentNode> findAll​(@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")
                                                                                                                                          java.lang.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)

      • getContentNode

        @ApiMethod(description="get a content node as JSON or XML, depending on extension or <tt>format</tt> request parameter or accept header")
@RequestMapping(value={"/latest/contentnodes/{uuid}","/v2/contentnodes/{uuid}"},
                produces={"application/json","application/xml"},
                method=GET)
@ApiResponseObject
public org.springframework.http.ResponseEntity<de.digitalcollections.model.api.identifiable.entity.parts.ContentNode> getContentNode​(@ApiPathParam(description="UUID of the content node, 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 de.digitalcollections.cudami.server.business.api.service.exceptions.IdentifiableServiceException
        Throws:
        de.digitalcollections.cudami.server.business.api.service.exceptions.IdentifiableServiceException

      • saveWithParentContentTree

        @ApiMethod(description="save a newly created top-level content node")
@RequestMapping(value={"/latest/contenttrees/{parentContentTreeUuid}/contentnode","/v2/contenttrees/{parentContentTreeUuid}/contentnode"},
                produces="application/json",
                method=POST)
@ApiResponseObject
public de.digitalcollections.model.api.identifiable.entity.parts.ContentNode saveWithParentContentTree​(@PathVariable
                                                                                                       java.util.UUID parentContentTreeUuid,
                                                                                                       @RequestBody
                                                                                                       de.digitalcollections.model.api.identifiable.entity.parts.ContentNode contentNode,
                                                                                                       org.springframework.validation.BindingResult errors)
                                                                                                throws de.digitalcollections.cudami.server.business.api.service.exceptions.IdentifiableServiceException
        Throws:
        de.digitalcollections.cudami.server.business.api.service.exceptions.IdentifiableServiceException

      • saveWithParentContentNode

        @ApiMethod(description="save a newly created content node")
@RequestMapping(value={"/latest/contentnodes/{parentContentNodeUuid}/contentnode","/v2/contentnodes/{parentContentNodeUuid}/contentnode"},
                produces="application/json",
                method=POST)
@ApiResponseObject
public de.digitalcollections.model.api.identifiable.entity.parts.ContentNode saveWithParentContentNode​(@PathVariable
                                                                                                       java.util.UUID parentContentNodeUuid,
                                                                                                       @RequestBody
                                                                                                       de.digitalcollections.model.api.identifiable.entity.parts.ContentNode contentNode,
                                                                                                       org.springframework.validation.BindingResult errors)
                                                                                                throws de.digitalcollections.cudami.server.business.api.service.exceptions.IdentifiableServiceException
        Throws:
        de.digitalcollections.cudami.server.business.api.service.exceptions.IdentifiableServiceException

      • update

        @ApiMethod(description="update a content node")
@RequestMapping(value={"/latest/contentnodes/{uuid}","/v2/contentnodes/{uuid}"},
                produces="application/json",
                method=PUT)
@ApiResponseObject
public de.digitalcollections.model.api.identifiable.entity.parts.ContentNode update​(@PathVariable
                                                                                    java.util.UUID uuid,
                                                                                    @RequestBody
                                                                                    de.digitalcollections.model.api.identifiable.entity.parts.ContentNode contentNode,
                                                                                    org.springframework.validation.BindingResult errors)
                                                                             throws de.digitalcollections.cudami.server.business.api.service.exceptions.IdentifiableServiceException
        Throws:
        de.digitalcollections.cudami.server.business.api.service.exceptions.IdentifiableServiceException

      • count

        @ApiMethod(description="get count of content nodes")
@RequestMapping(value={"/latest/contentnodes/count","/v2/contentnodes/count"},
                produces="application/json",
                method=GET)
@ApiResponseObject
public long count()

      • getIdentifiables

        @ApiMethod(description="get identifiables of content node")
@RequestMapping(value={"/latest/contentnodes/{uuid}/identifiables","/v2/contentnodes/{uuid}/identifiables"},
                produces="application/json",
                method=GET)
@ApiResponseObject
public java.util.List<de.digitalcollections.model.api.identifiable.Identifiable> getIdentifiables​(@PathVariable
                                                                                                  java.util.UUID uuid)

      • saveIdentifiables

        @ApiMethod(description="save identifiables of content node")
@PostMapping(value={"/latest/contentnodes/{uuid}/identifiables","/v2/contentnodes/{uuid}/identifiables"},
             produces="application/json")
@ApiResponseObject
public java.util.List<de.digitalcollections.model.api.identifiable.Identifiable> saveIdentifiables​(@PathVariable
                                                                                                   java.util.UUID uuid,
                                                                                                   @RequestBody
                                                                                                   java.util.List<de.digitalcollections.model.api.identifiable.Identifiable> identifiables)

      • addIdentifiable

        @ApiMethod(description="add identifiable to content node")
@PostMapping({"/latest/contentnodes/{uuid}/identifiables/{identifiableUuid}","/v2/contentnodes/{uuid}/identifiables/{identifiableUuid}"})
@ResponseStatus(OK)
@ApiResponseObject
public void addIdentifiable​(@PathVariable
                            java.util.UUID uuid,
                            @PathVariable
                            java.util.UUID identifiableUuid)